list_endpoints

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

The description implies a read-only operation (listing), which is accurate. However, since no annotations are provided, the description carries the full burden. It could explicitly state that the tool does not modify any resources or require special authentication beyond what is already specified in the auth parameter.

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?

Single sentence that front-loads the main action and optional filters. No wasted words, but could benefit from a brief note on default behavior (e.g., includeDeprecated defaults to true).

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 the absence of an output schema, the description should hint at what the response contains (e.g., list of endpoint objects). It also omits details about pagination (limit parameter) and the fact that includeDeprecated defaults to true. For a tool with 7 parameters and complex nested objects (auth), this is insufficient.

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 no new parameter meaning beyond stating that there is optional filtering by tag, method, or path fragment, which is already evident from the schema parameter descriptions.

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 action (List endpoints), the resource (discovered OpenAPI document), and the optional filtering capabilities (tag, method, path fragment). It distinguishes itself from sibling tools like call_endpoint, which actually invokes endpoints.

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 implies the tool is for listing/browsing endpoints, but does not explicitly state when to use this versus other listing tools like search_endpoints or find_related_endpoints. No exclusions or context about prerequisites (e.g., requiring a prior detect_openapi call).

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