hotkeys

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

With no annotations, the description carries full behavioral burden. It only says 'List hotkeys,' implying a read-only operation, but it does not disclose what the output format is, whether pagination exists, or how parameters like 'total', 'verbose', or 'all' affect behavior. The description fails to add value beyond the bare action.

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 extremely short (2 words), which might be considered concise, but it omits essential information. It is not structured to front-load key details; instead, it under-specifies the tool's function. The conciseness comes at the expense of completeness.

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 5 parameters, 0% annotation coverage, no output schema, and no parameter explanations, the description is severely incomplete. An agent cannot know what the tool returns, how parameters modify results, or how to use it effectively. The context is entirely missing.

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 coverage is only 20% (only 'vault' has a description). The tool description does not explain any of the 5 parameters, such as 'format', 'total', 'verbose', or 'all'. Since coverage is low (<50%), the description should compensate but does not, leaving the agent without crucial information to use parameters correctly.

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 states 'List hotkeys,' which is a clear verb+resource pair. However, it does not distinguish from the sibling tool 'hotkey' (singular) and gives no indication of what hotkeys are listed (e.g., all? current? workspace?). The purpose is clear but lacks specificity and sibling differentiation.

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 usage guidance is provided. The description does not indicate when to use this tool versus the similar sibling 'hotkey' or any other tool. There is no mention of prerequisites, typical scenarios, or when not to use it.

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