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 full burden. It discloses that include_notes and include_params can make output large, hinting at performance implications. However, it doesn't mention whether this is a read-only operation or any side effects, but this can be inferred from nature.

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 concise and front-loaded. The first sentence states the tool's purpose, followed by a clear parameter section. Every sentence earns its place.

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 tool is a simple dump with optional parameters, and the description covers what it returns. An output schema exists, so return values don't need to be explained. The description is complete for the tool's simplicity, but could arguably mention the default behavior of include_notes=true which isn't in schema (schema says default true, description says include notes are optional).

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% (the description does not repeat the schema info), but the description adds meaningful semantics: it explains that include_notes includes MIDI notes of every clip (large output) and include_params includes every device parameter (very large output). This adds value beyond the schema's type/default.

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 tool's purpose: 'Dump the whole project state in one call' and lists the specific resources included (tracks, clips, devices, scenes, returns, master and cue points). This is a specific verb+resource combination that distinguishes it from sibling tools like get_track_info or get_session_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?

The description implies that this is a comprehensive snapshot tool meant to be used when you need the entire project state at once, as opposed to individual getters. However, it doesn't explicitly say when NOT to use it or mention alternatives.

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