add_parameter

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

With no annotations, the description discloses key behaviors: appending to <ReportParameters> (creating if absent) and the nuance that booleans are only emitted when an explicit value is supplied. This adds meaningful behavioral context beyond the schema.

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?

Three concise sentences, each adding distinct value: core purpose, post-creation workflow, and a behavioral caveat. No wasted words, well front-loaded.

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 8 parameters, no output schema, and no schema descriptions, the description is too minimal. It omits explanations for required parameters (path, name, type) and optional ones (hidden, prompt, etc.), leaving the agent underinformed.

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 has 8 parameters with 0% description coverage. The description only hints at boolean behavior for the 'type' parameter. It does not explain 'name', 'path', 'hidden', 'prompt', or other fields, leaving the agent to infer their 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?

The description clearly states 'Create a new ReportParameter with a minimal valid declaration', using a specific verb and resource. It distinguishes from sibling 'add_' tools by naming the resource type and mentioning companion tools like set_parameter_available_values.

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 explains the tool's role in creating minimal declarations and directs to use set_parameter_available_values / set_parameter_default_values for value lists. It implies when to use (initial creation) but lacks explicit when-not-to-use or alternatives for updating existing parameters.

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