get_session_snapshot

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

No annotations are provided, so the description carries the behavioral burden. It discloses that notes and device parameters are optional and rarely included, but it does not explicitly confirm the operation is read-only, describe performance or payload size risks, or explain when to set include_notes/include_params to false.

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 dense, purposeful opening paragraph followed by a compact parameter list. It is front-loaded and avoids restating schema trivia or padding.

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?

The output schema exists, so return value explanations are not needed. The description covers primary content, optional flags, and usage framing. It could still go further by noting the potential cost of a full-session snapshot and when to prefer more focused siblings like get_track_info or get_clip_notes.

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 compensate, and it does: each parameter gets a meaningful explanation, including user_prompt's telemetry purpose. This adds genuine value beyond the raw boolean/string schema.

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 starts with a specific verb+resource ('Capture a full project state snapshot') and then enumerates its exact scope: session metadata, every track, mixer, devices, session/arrangement clips. This clearly distinguishes it from lighter siblings like get_session_info or get_track_info.

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?

It gives explicit usage context: the tool is for trajectory recording and versioning musical state S_t -> S_{t+1}. However, it does not explicitly state when not to use it or suggest a lighter alternative for one-off, targeted reads.

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