discover_specs

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

With no annotations, the description explains the tool's non-destructive scanning behavior and output format. Reveals it returns a suggested_input for serve_locally, which is helpful. Could add depth limit or side effects, but adequate.

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?

Two sentences, no fluff, efficient word choice. First sentence states action and output, second gives usage context.

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?

Simple single-parameter tool with clear purpose. Description covers input, scan behavior, and output. Lacks output schema but hints at return value. Complete enough for this complexity.

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?

Only one parameter 'dir' with 0% schema coverage. Description implies it is a directory path but does not describe its format or constraints. Baseline 3 for single required parameter with implicit meaning.

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?

Description clearly states the tool scans a directory and reports OpenAPI spec files and static subdirs, with specific details like returning a suggested_input for serve_locally. This distinguishes it from siblings like peek_openapi.

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?

Explicitly provides user utterances that trigger this tool ('I have a folder of specs/files, what's in it?' or 'mock this directory'), giving clear context. Lacks explicit when-not-to-use or alternatives, but sufficient.

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