List API Endpoints

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the agent knows it's safe. The description adds behavioral context about return fields, pagination for large APIs, and the presence of a cacheFile path for each entry, which is useful for post-processing.

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 four short sentences, each serving a purpose: listing, filtering, pagination, and return detail. It is front-loaded with the primary action and contains no filler.

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 read-only annotations and optional parameters, the description covers what the tool returns, how to filter, and how to paginate. The absence of an output schema is mitigated by the explicit mention of returned fields and cacheFile. It is adequate 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 baseline is 3. The description adds value by grouping parameters into filters (tag, method, keyword) and pagination (limit, offset), and by explaining that cacheFile paths are included in results, which is not in the schema. This clarifies how parameters work together.

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 it lists all API endpoints with specific fields (method, path, summary, tags), which distinguishes it from sibling tools like swagger_get_endpoint (single endpoint) and swagger_list_tags (tags only). It also mentions filtering and pagination, giving a complete sense of the tool's function.

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 explains the tool is for listing endpoints with filtering options and pagination, and mentions that each entry includes a cacheFile path for detailed info, implying the next step. However, it doesn't explicitly name alternatives like swagger_get_endpoint for single-endpoint details, so it lacks a direct when-not-to-use statement.

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