Skip to content

docs(mcp): explain content and structuredContent tool results - #19

Merged
joeldickson merged 1 commit into
ShipLean:mainfrom
jdotc1:docs/mcp-tool-results-20261102
Nov 4, 2026
Merged

joeldickson merged 1 commit into
ShipLean:mainfrom
jdotc1:docs/mcp-tool-results-20261102

Conversation

@jdotc1

@jdotc1 jdotc1 commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

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 equivalent structuredContent object, and isError handling. 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.
  • External URL check was not run because outbound access is restricted.

Describe summary, Markdown and JSON blocks for normal and error results,
including client-truncation guidance.

Refs ShipLean#16
@joeldickson
joeldickson merged commit 62d611a into ShipLean:main Nov 4, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the MCP tool result shape

2 participants