Get a code example

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

Annotations already establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds a genuine behavioral signal beyond that: "Uses one request," which tells the agent the call cost is a single API round-trip — useful for budgeting. It stops short of stating auth requirements or whether snippets are compilable/complete.

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?

Two sentences, front-loaded with the deliverable, with the enum expansion packed into a single clause. The middle list is long but each item adds meaning to a topic value, so it earns its space; the fragment-style opening sentence is slightly rough but not wasteful.

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?

With no output schema, the description still communicates what comes back — a working snippet in the requested platform's language for the requested task — and that the call is a single request. It leaves open details like snippet length, snippet completeness, or error behavior, but nothing an agent needs to call it correctly is missing.

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 description coverage is 0%, so the description carries the burden — and it does, translating opaque enum values into meaning: play-video is "playing the looping MP4 and refreshing its signed link," handle-errors is "error and rate-limit handling," backend-proxy is "keeps your key off the device." That is real semantic value beyond the raw enum tokens, though the platform enum is left entirely to the schema.

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 names the deliverable ("a working snippet") and scopes it by platform and task, which is a specific verb+resource pairing an agent can distinguish from reference-oriented siblings like get_endpoint_reference. It does not explicitly contrast itself with siblings such as diagnose_request or generate_types, so it falls short of full differentiation.

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?

Usage is only implied through the enumeration of tasks ("listing and paging exercises, playing the looping MP4...") which mirrors the topic enum. There is no explicit when-to-use versus when-to-use-an-alternative guidance, nor prerequisites such as needing an API key first.

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