get-code-example

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses framework-neutral behavior and that it returns a snippet, but does not discuss permissions, error scenarios, or response format. Since no annotations are provided, the description carries the full burden.

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?

Three focused sentences with no wasted words: states purpose, usage guidelines, and sibling reference.

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?

Adequately complete for a simple one-parameter tool with no output schema; could further specify snippet content (e.g., imports), but not essential.

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?

Schema coverage is 100%, so the parameter is documented. The description adds no additional meaning beyond the schema, but the enum values convey the valid operations implicitly.

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 clearly states it retrieves a short, focused TypeScript snippet for a specific SDK operation, and distinguishes it from the sibling tool get-sdk-docs.

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?

Explicitly states when to use this tool ('when you need the exact shape of a tricky SDK call') and provides an alternative ('use get-sdk-docs instead').

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.