get_sdk_snippet
Get a repository SDK example and its documented verification status. Grant items only on verified backend delivery.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| platform | Yes |
Get a repository SDK example and its documented verification status. Grant items only on verified backend delivery.
| Name | Required | Description | Default |
|---|---|---|---|
| platform | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds that the result includes documented verification status and a gating rule about granting items only on verified backend delivery, but it does not explain the return format or how verification status is determined.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The definition is short and front-loads the retrieval action in the first sentence. The second sentence is terse but its relationship to the retrieval result is somewhat ambiguous, keeping it from being fully efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
This is a simple read-only tool with one enum parameter and annotations covering safety, and the description names the returned components: an SDK example and verification status. However, it omits the meaning of the platform parameter and does not clarify what verification status represents, leaving meaningful gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The sole parameter, platform, has 0% schema description coverage and is not mentioned in the description. The enum values show allowed platforms, but the description adds no meaning about platform selection, required behavior, or defaults, so it does not compensate for the missing schema documentation.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Get a repository SDK example and its documented verification status.' This is clear enough to distinguish it from get_pricing and search_docs by resource, though it does not explicitly name or contrast those siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives no explicit guidance on when to use this tool versus alternatives such as search_docs or get_pricing. The sentence about granting items only on verified backend delivery is a policy statement, not a clear invocation condition for this retrieval tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.