Get endpoint reference

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description still adds real value by noting the source of truth ('straight from the OpenAPI spec') and the cost profile ('Uses one request'), which tells the agent this is a cheap, non-destructive lookup.

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 short sentences, zero filler: what it returns, the no-argument mode, and the cost. The payload enumeration is front-loaded and each sentence earns its place.

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 carries the burden of describing return contents and does so explicitly (parameters, response shape, errors, curl example). For a single optional-parameter read tool with strong annotations, this is nearly complete, missing only any note on response size or formatting.

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 baseline is 3, but the description adds genuine semantics by stating that omitting the endpoint lists all endpoints, which the schema alone conveys only implicitly via zero required fields. It also adds 'any v2 endpoint', clarifying the accepted scope beyond the schema's example formats.

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 a concrete resource (v2 endpoints) and enumerates exactly what comes back: parameters, response shape, errors, and a curl example, sourced from the OpenAPI spec. An agent can tell this is a spec-lookup tool, though the 'curl example' payload slightly overlaps with the sibling get_code_example without an explicit disambiguation.

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?

'Call with no endpoint to list them all' is a concrete usage instruction covering the zero-argument case. It gives clear context for when to reach for this tool but names no exclusions or alternatives among siblings like diagnose_request or get_code_example.

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