Update structuredContent guidance for TextContent blocks#2847
Open
evalstate wants to merge 1 commit into
Open
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove the SHOULD requirement to duplicate structuredContent within a TextContent block, relaxing guidance to match field usage.
Motivation and Context
Problem: Usage of
structuredContentin the field has diverged from the specification. In particular, the marquee MCP Apps extension provides guidance on usingstructuredContentin a way that contradicts the "SHOULD" guidance in the current MCP Specification.Usage in the Field: Tool Result
structuredContentis normally used to deliver information to Host applications for pre-processing before presenting to the model. Primary use-cases are:Examples of contradictory guidance:
From the MCP Apps specification:
From the OpenAI Apps SDK Developer guide:
NB: Discussion of the difference between these two specifications is out of scope - they are presented to highlight the discrepancies to the MCP Specification.
Proposed Action:
The current MCP Specification states:
This guidance is contradictory to current practice.
The proposal is to update the guidance to instead read:
Reduces ambiguity in the specification, improves developer experience, provides greater flexibility for MCP Server authors to return most appropriate representations of content.
How Has This Been Tested?
Breaking Changes
Developers adhering to the old guidance do not need to make any changes. Developers presenting other content (e.g. markdown, MCP Apps guidance) are no longer violating the SHOULD guidance.
Types of changes
Checklist
Additional context
Example thread of confusion caused by existing guidance: https://discord.com/channels/1358869848138059966/1411057080902746293