List Swagger Sources

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

The description adds valuable behavioral nuance beyond the annotations: it explains that fetchedAt may be null (meaning not yet loaded) and that totalInterfaces is only shown when loaded. This clarifies caching behavior and return semantics, which the annotations do not cover. No contradictions with annotations.

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 concise and well-structured: a clear opening sentence, a bulleted list of return fields, and a usage tip. Every sentence serves a purpose, and it is easy to scan.

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 parameterless read-only list operation with an output schema, the description is fully complete. It explains what is returned, including edge cases, and how it fits into the broader workflow with sibling tools.

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?

The tool has zero parameters, so the baseline is 4. The description focuses on return fields rather than parameters, which is appropriate. It doesn't need to add parameter details because none exist.

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's specific function: 'List all configured Swagger documentation sources and their cache status.' It uses a strong verb ('List') and a specific resource ('Swagger documentation sources'), and effectively distinguishes itself from siblings by noting it should be used before swagger_search_api.

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?

Explicit usage guidance is provided: 'Use this before calling swagger_search_api to discover which services are available.' This tells the agent exactly when to employ this tool and mentions a sibling tool as the subsequent step.

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