fetch_example

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

Annotations already declare readOnlyHint=true, so the read-only nature is known. The description adds that it returns content and learning context, but does not disclose any additional behavioral traits such as potential errors or permissions needed.

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 description is concise with a clear first sentence. The Args and Returns sections add useful structure without being overly verbose. Could be slightly more front-loaded by integrating the Examples section into the initial sentence.

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?

Given a single required parameter, no output schema, and annotations present, the description adequately covers the tool's purpose and return content (content, metadata, learning objectives, patterns). It lacks discussion of error handling or edge cases, but is sufficient for a simple fetch operation.

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 schema has no description for the single parameter, but the description provides a clear explanation: 'The filename of the example to fetch (e.g., 'serverless-on-aws.ilograph').' This adds meaning beyond the schema and compensates for the 0% schema description coverage.

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 it retrieves a static example diagram with content and learning context, clearly specifying the verb and resource. It implicitly differentiates from sibling tools like list_examples (which lists names) and fetch_documentation_tool, but does not explicitly state distinctions.

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?

No guidance on when to use this tool versus alternatives. It does not specify prerequisites, conditions, or mention sibling tools like list_examples for discovering available example names.

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