createSpec

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

Annotations indicate readOnlyHint=false, destructiveHint=false, idempotentHint=false. The description adds behavioral context beyond annotations: file size limit (12 MB), multi-file root file requirement, and folder creation via '/' in path. 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 one-sentence purpose, followed by bullet-pointed notes. Every sentence provides necessary information without redundancy. It is front-loaded with the core action, and the notes are clearly separated.

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 complexity (multi-file specs, multiple spec types, folder creation), the description covers all essential constraints: supported types, single root file, folder creation via '/', and file size limit. No output schema exists, but the description is adequate for an agent to understand behavior and constraints.

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?

Schema coverage is 100%, so schema already documents all parameters. The description adds value by clarifying that file paths with '/' create folders and that multi-file specs require a ROOT file type, which supplements the schema's enum descriptions. However, it does not add extensive new meaning for most parameters.

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 it creates an API specification in Postman's Spec Hub, distinguishing it from sibling tools like createSpecFile (which creates individual files) and updateSpecProperties (which updates existing specs). It mentions single or multi-file options, making the purpose specific 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?

The description provides implicit usage context by listing supported spec types, file path behavior, and multi-file constraints (only one root file, 12 MB limit). However, it does not explicitly state when to use this tool versus alternatives like createSpecFile or updateSpecProperties, which would be clearer.

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