createSpec

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

No annotations are provided, so the description must carry the behavioral burden. It discloses supported API specification formats (OpenAPI, AsyncAPI, etc.) and the maximum file size of 10MB, which are critical behavioral constraints not in the schema. However, it does not mention side effects, auth requirements, or expected responses.

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 containing all key information: action, supported formats, and constraint. No filler or redundancy. It is front-loaded with the primary action and efficiently conveys the essential details.

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?

The tool is relatively complex (multiple formats, file handling, size limit) and lacks an output schema. The description covers input constraints well but omits return value details (e.g., does it return the created spec ID?). For a creation tool, this omission limits completeness.

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?

With 100% schema coverage, the baseline is 3. The description adds value beyond schema by clarifying the file path convention ('Use '/' in path to create folders') and implicitly linking the 'type' parameter to the listed formats. This extra guidance improves parameter understanding.

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 begins with 'Creates an API spec in Postman's Spec Hub,' clearly stating the verb and resource. It also lists supported formats and a file size limit, further specifying the tool's function and distinguishing it from siblings like 'createSpecFile' or 'getSpec'.

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 usage when creating a spec, but does not explicit when to use this tool over alternatives like 'createSpecFile'. Given the sibling tools include file-level creation, the absence of comparative guidance leaves the agent to infer usage from context.

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