get-snippet

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

Annotations already declare readOnlyHint=true and idempotentHint=true, establishing safety. The description adds useful behavioral details not in annotations: it returns the first available snippet without an id and provides additional snippet ids if more are available. This enriches understanding of the tool's output behavior.

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 five sentences, all information-dense and front-loaded with the core purpose. It wastes no words, and every sentence adds value (purpose, behavior, alternatives).

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?

For a simple two-parameter tool with annotations and an output schema, the description covers purpose, usage, alternatives, and behavioral nuances. It provides all needed context for an agent to select and invoke the tool correctly.

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 baseline is 3. The description adds value by clarifying the optionality of 'id' and its effect ('Returns the first available snippet when called without an id'), and by giving examples for metadataType. This supplements the schema descriptions with behavioral semantics.

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 the tool fetches a Fluent code snippet for a ServiceNow metadata type, with concrete examples ('business-rule', 'script-include'). It also distinguishes itself from sibling tools by explicitly naming get-api-spec and get-instruct.

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 explicitly provides when to use the tool and when not to: 'For API specifications, use get-api-spec instead. For best practices, use get-instruct instead.' It also explains behavior when called without an id, which informs usage.

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