Skip to content

Document the MCP tool result shape #16

Closed

Description

@joeldickson

ShipLean/ShipLean#24 changed the shape of every MCP tool result. content is now the summary line, then the Markdown for get_brief and planning_guide, then the same JSON as structuredContent, errors included. Before that, clients that only show content to the model, such as Cursor through a gateway, saw one summary line and nothing else.

agents/tools.mdx documents the error shape under Request limits and errors, but not the normal result. structuredContent isn't mentioned anywhere on the site.

To do

Add a short section to agents/tools.mdx on the result shape. Include what to do if an agent only sees the summary line: its client is hiding the rest, and it should tell the person rather than search for the output.

This needs to go outside the generated block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions