Skip to content

docs(sdk): describe structured MCP results #771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
georgeglarson wants to merge 2 commits into
base: main
Choose a base branch
from
+12 −0
Open

docs(sdk): describe structured MCP results #771

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18eb9d1
docs(sdk): describe structured MCP results
georgeglarson Aug 28, 2026
63ef37e
Merge branch 'main' into feat/mcp-structured-results
georgeglarson Aug 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions sdk/arch/mcp.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,18 @@ flowchart TB
6. **Observation Creation:** Wrap in `MCPToolObservation`
7. **Error Handling:** Catch exceptions, return error observations

MCP tools can return two kinds of data beyond their text and image content:
`structuredContent`, machine-readable result data for clients that render or
process it, and result `_meta`, protocol metadata about the call.
`MCPToolObservation` preserves both in the `structured_content` and
`result_meta` fields. They serialize with the observation, so API and websocket
clients receive them, but they are not sent to the model.

Masking follows the same rules as text output: when a conversation is attached,
registered secrets inside these fields are replaced before the observation is
persisted or delivered, walking nested keys and values. If a field cannot be
masked safely, it is dropped rather than delivered unmasked.

### MCPToolExecutor

Executors bridge SDK actions to MCP calls:
Expand Down
Loading