Repository navigation
docs(mcp): explain content and structuredContent tool results - #19
Merged
Merged
Conversation
Describe summary, Markdown and JSON blocks for normal and error results, including client-truncation guidance. Refs ShipLean#16
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.
Summary
The tool list documented errors but did not explain normal MCP result envelopes after ShipLean/ShipLean#24. This adds a short section explaining
content(summary, optional Markdown, then JSON), the equivalentstructuredContentobject, andisErrorhandling. When a client exposes only a summary, it instructs agents to tell the user the response is incomplete and obtain the full JSON rather than inventing a plan token or missing tool output.Closes #16.
Validation
pnpm check— 0 errors, warnings, or hints across 53 files.pnpm build— 52 pages built; all internal links valid.