store_api_spec

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

With no annotations, the description carries the full burden. It mentions 'parse' which gives a hint of behavior beyond storage, but it does not disclose side effects like overwriting existing specs, validation behavior, or return format. For a store operation, this leaves important behavioral questions unanswered.

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 with no filler words. It is front-loaded with the action verb and directly states the resource. Every word earns its place, making it exceptionally concise and well structured for such a short description.

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 tool's simplicity and the schema's complete parameter coverage, the description is minimally viable. However, it omits any mention of what happens after parsing, whether the spec is upserted or duplicates are rejected, and there's no output schema to fill these gaps. For a CRUD-style store tool, this is adequate but not richly contextual.

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 input schema provides 100% coverage with descriptions for all parameters, so the description does not need to explain them. The tool description adds no additional parameter semantics, so the baseline of 3 is appropriate.

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 'Store and parse OpenAPI/Swagger specification' uses specific verbs ('store', 'parse') and a specific resource, clearly distinguishing it from sibling tools like get_api_spec or list_api_specs. It conveys the core function without ambiguity.

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 used when you want to persist and process an OpenAPI/Swagger specification, but it does not explicitly state when to use it versus alternatives (e.g., storing session context or memory). No exclusions or alternative references are provided.

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