get_fx_envelope

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

With no annotations, the description must carry the behavioral burden, and it does disclose a key trait: this is a get-or-create operation with a side effect (the envelope is created if it doesn't exist), plus the return shape. It omits error/permission behavior when indices are invalid, so the disclosure is helpful but incomplete.

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?

Purpose is front-loaded, and the Args/Returns structure is easy to scan. Minor redundancy: 'The envelope is created if it doesn't exist' restates the 'or create' in the opening line, but overall the text is tight.

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?

For a tool with no annotations, no output schema, and 0% schema coverage, the description does compensate by spelling out the return object fields (envelope_name, param_name, point_count, indices). It still leaves the other two parameters and failure modes unexplained, so it is adequate but not complete.

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 0%, so the description must compensate, but it only explains param_index (0-based, with a helper tool for valid values). track_index and fx_index receive no explanation at all, leaving two of three required parameters entirely undocumented.

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?

States a specific verb+resource: 'Get or create an automation envelope for an FX parameter', with a concrete example (a flanger knob in Guitar Rig) that grounds the concept. It's clear the tool returns/creates the envelope object itself. It doesn't explicitly distinguish itself from the related envelope siblings (get_fx_envelope_points, add_fx_envelope_point, clear_fx_envelope), so it falls just short of a 5.

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?

Provides useful operational guidance: use track_fx_get_num_params() to find valid parameter indices, and notes the envelope is auto-created if absent. However, it never explains when to reach for this tool versus get_fx_envelope_points, add_fx_envelope_point, or clear_fx_envelope, leaving the workflow position implied rather than stated.

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