generate_vcv

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

With no annotations, the description fully covers behavior: it explains that the complete .vcv content is always returned, instructs the agent to present it directly and stop, and warns against any file/shell operations. It also clarifies the outputPath parameter is optional.

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 efficiently structured: purpose, important usage note, list of supported plugins, and explicit post-call instructions. Every sentence earns its place without unnecessary repetition.

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 complexity of generating a patch file, the description covers all necessary context: what it does, prerequisites, supported plugins, output behavior, and what to avoid after. No output schema is present, but the description clearly explains the returned content.

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% with detailed descriptions for each parameter. The description adds value by providing usage context (e.g., using list_vcv_modules for correct slugs) and guidance on optional outputPath. It does not repeat schema info but adds operational semantics.

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 explicitly states that the tool generates a VCV Rack .vcv patch file from a JSON specification, using a registry of module port/param IDs. It clearly distinguishes itself from sibling tools by instructing users to use list_vcv_modules first.

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 explicit when-to-use guidance: 'Use list_vcv_modules first to look up exact module slugs and port names — do NOT guess.' It also lists supported plugins and gives post-call instructions (do not run file operations).

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