piano_roll_read

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does state that this is a read operation returning all notes, implying no mutation, but it omits the note data format, the meaning of 'current' (channel, pattern, or selection), and any error or edge-case behavior.

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?

One short, front-loaded sentence communicates the operation and output scope without wasted words. The parenthetical '(returns all notes)' adds useful precision without redundancy.

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 parameterless read-only tool this is nearly sufficient, but no annotations or output schema exist, so an agent still does not know the note structure or the exact target of 'current'. A brief clarification of the returned note fields or the active context would make it 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?

The tool has zero parameters, so the schema fully covers the input side and there is no parameter ambiguity for the description to clarify. The baseline of 4 is appropriate because no parameter burden exists.

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 uses the specific verb 'Read back' with a clear resource, the current piano-roll state, and explicitly says the output is 'all notes'. This cleanly distinguishes it from write/edit siblings such as piano_roll_add_notes, piano_roll_delete_notes, and piano_roll_clear.

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 intended use as a read-only getter of current notes is clear, but the description gives no explicit guidance about when not to use it or what alternative to prefer. Sibling tools like piano_roll_status and piano_roll_read_patterns_autolocate exist, yet no comparison is offered.

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