list_api_specs

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It implies a read-only operation via the verb 'list', but does not explicitly state that it is non-destructive or describe edge cases like empty lists or pagination. The addition of 'with metadata' gives a partial hint about the return format, but underlying behavior details are sparse.

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 a single sentence, fully front-loaded with the action ('List') and object ('all stored API specifications with metadata'). There is no filler or redundant information, making it highly concise and well-structured.

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 simple, no-parameter list tool, the description is largely complete. It covers what the tool does and hints at the return content (metadata). However, it does not specify what 'metadata' includes or whether the list is exhaustive, and there is no output schema to fill this gap. Slightly more detail would make it fully complete.

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?

This tool has zero parameters, so the baseline for parameter semantics is 4. The description does not need to explain parameters because there are none, and the empty schema already confirms this. No additional parameter context is needed.

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 verb 'list' and the resource 'stored API specifications with metadata', which distinguishes it from sibling tools like get_api_spec (retrieve single) and delete_api_spec (delete). The purpose is immediately apparent and unambiguous.

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?

No explicit guidance is provided about when to use this tool versus alternatives. However, the name 'list_api_specs' and the phrase 'List all' imply it is the go-to for getting an overview of all stored specs. It lacks explicit exclusions or comparisons to related tools like search_api_endpoints, so usage context is only implied.

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