iyke_state

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

No annotations provided, so description carries full burden. It details the structure of shell.panes (leaves with id, focused, activeTabIdx, tabs) and explains how to use the output (e.g., use leaves[].id with specific tools). It does not mention destructive actions or auth needs, but as a read-only state getter, the behavioral disclosure is adequate.

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?

Description is three sentences, front-loaded with purpose, then output shape, then usage guidance. Every sentence adds value with no redundancy. Highly efficient.

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?

Considering no output schema, the description provides a thorough breakdown of the return value shape and how to use it with sibling tools. It fully explains the state structure and usage context, making it complete for a read-only tool.

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 has 0 parameters with 100% coverage, so description need not add parameter info. Baseline 4 applies; description adds no param details but that is appropriate given no parameters exist.

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 'Get the current state of the Ikenga desktop app' with specific components (sidebar mode, focused pane route, pane tree). It distinguishes from sibling tools by indicating it should be called before iyke_go/iyke_mode/iyke_focus/iyke_close, giving a clear resource and usage context.

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?

Explicitly says 'Call this before iyke_go / iyke_mode / iyke_focus / iyke_close to check what the user is currently looking at,' providing clear guidance on when to use. No explicit when-not-to-use, but the instruction implies a prerequisite role, which is sufficient for a read-only state tool.

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