docs(shopping): add MCP method, param, and result descriptions for agent tooling parity#601
Open
prasad-stripe wants to merge 2 commits into
Open
docs(shopping): add MCP method, param, and result descriptions for agent tooling parity#601prasad-stripe wants to merge 2 commits into
prasad-stripe wants to merge 2 commits into
Conversation
…ent tooling parity
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 MCP (JSON-RPC) service definition for Shopping lacked descriptions on most methods, all params, and all results. The REST (OpenAPI) counterpart already has these. This creates a parity gap that directly impacts AI agent usability: when an LLM reads the MCP tool definitions, descriptions are the primary signal for understanding what a method does, what each parameter means, and what to expect in the result.
This PR adds:
request-id(UUID) to the meta schema, mapping to the HTTP Request-Id header for cross-transport tracingWhy this matters
MCP is the agent-native transport. AI agents consuming these tools via JSON-RPC rely on
descriptionfields to determine which method to call, what parameters to provide, and how to interpret results. Without descriptions, agents must infer behavior from names alone, leading to misuse, unnecessary retries, and degraded user experiences.The REST spec already has this information; the MCP spec should not be a second-class citizen for the same service.
Test plan