ui_open_piano_roll_for_channel

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

With no annotations, the description must fully disclose behavior. It only states 'Open the piano roll,' without detailing side effects, error handling, or whether it changes the focused window. The optional pattern switch is mentioned but not explained.

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 a single sentence with no redundant words. It is front-loaded and efficiently communicates the core purpose and optionality.

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 simple UI action with two parameters, the description covers the basic functionality. However, it lacks context about prerequisites, potential errors, and how it relates to other piano_roll tools. No output schema is needed, but behavioral expectations are minimal.

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%, so the description must add meaning. It explains 'channel' as the target and 'pattern' as optional to switch first. However, it does not clarify indexing (0- or 1-based) or valid values for the pattern (e.g., pattern index or name).

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: opening the piano roll for a given channel, with an optional pattern switch. It uses a specific verb and resource, differentiating it from sibling piano_roll tools that modify notes rather than open the UI.

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 piano_roll_add_notes or ui_scroll_to_channel. The description does not mention preconditions, such as whether the channel must already exist in the project.

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