get_sound_effect_state

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

The description goes beyond no annotations by disclosing a known limitation: live state read may fail due to Electron context isolation, returning rendererReadable=false and rendererError. It also guarantees that the 6 stages are always returned.

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 reasonably concise, with two paragraphs. The first paragraph front-loads the main return values, and the second explains a limitation. Every sentence serves a purpose, though it could be slightly shorter.

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?

Given no output schema, the description adequately covers the return data: per-stage settings, active pack, master volume, overrides, and potential error fields. It also explains the limitation, providing complete context for the tool's current behavior.

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?

No parameters exist, so the description has no param details to add. However, it adds value by describing the return structure in detail, which compensates for the lack of output 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 clearly states that the tool returns the current sound-effects configuration including per-hook-stage settings, active sound pack, master SFX volume, and per-stage overrides. It specifies the 6 hook stages and distinguishes itself from sibling tools that set these values.

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 explicit guidance on when to use this tool versus alternatives is provided. The description focuses on what it returns and a limitation, but does not mention when-not to use or suggest alternative tools.

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