document_add_parameter_definition

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

The description says 'Add' but does not disclose what happens if the definition already exists (overwrite? error?), whether the change is reversible, or any permission requirements. No annotations exist to cover these gaps.

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?

Single sentence with no filler, but very brief. Could be slightly more informative without sacrificing conciseness.

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 has three parameters and no output schema or annotations, the description should explain the purpose of reusable definitions and how they relate to other tools in the domain (e.g., 'document_add_parameter'). It lacks this context.

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 the schema documents the parameters. The description adds no extra meaning—for example, it does not explain what a valid 'parameter' JSON string should contain or provide an example.

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 action ('Add') and the resource ('reusable parameter definition'), which distinguishes it from tools like 'document_add_parameter' that add parameters to operations. However, it could be more explicit about what 'reusable' means in this context.

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 guidance on when to use this tool versus alternatives like 'document_add_parameter' or 'document_add_header_definition'. The description does not clarify the distinction between adding a reusable definition and adding a parameter directly to an endpoint.

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