plugin_add_macro

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

With no annotations, the description carries the behavioral burden. It discloses that the operation adds a single 0..1 MacroParameter and that macros drive multiple underlying params via assignments. However, it does not mention side effects, prerequisites like an existing plugin, whether assignments are created automatically, or what the return/response is.

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 two sentences with no filler. The action and resource are front-loaded, and the second sentence adds valuable conceptual context about macros without repeating the tool name or schema.

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?

Despite having 5 parameters, 3 required, no annotations, and no output schema, the description does not explain parameter roles, required inputs, preconditions, or expected results. An agent would need additional information to correctly call this tool with confidence.

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 description coverage is 0%, and the description does not explain track_id, plugin_id, name, value, or default_value. The phrase 'single 0..1 knob' hints at the value range but does not map to any specific parameter, leaving most required parameters semantically unexplained.

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 opens with a specific verb and object: 'Add a MacroParameter (single 0..1 knob) to a plugin.' It clearly identifies the resource and distinguishes this tool from sibling plugin tools like plugin_add, plugin_set_param, and plugin_add_reverb by naming the MacroParameter concept and its multi-param assignment role.

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 clear usage context by explaining that macros are 'the canonical Tracktion way to expose a single control that drives multiple underlying params via assignments.' This implies when the tool should be used, though it does not explicitly list alternatives or exclusion conditions.

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