check_speakeasy

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

Describes the warning behavior (WARN not ERROR) and the fallback chain for locating the helper, providing good transparency beyond what annotations (none provided) would cover.

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?

Concise two-sentence description: first sentence states purpose, second explains behavior and fallback. No unnecessary words, front-loaded key information.

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?

Completeness is high for a simple check tool with no parameters and no output schema. Covers return value, behavior on failure, and fallback chain. Missing output format detail but not critical.

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 baseline score of 4 applies. Description adds behavioral context beyond schema but does not need to explain parameters.

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?

Clearly states the tool returns speakeasy-cli version and Python module availability. Uses specific verb 'return' and resource, distinct from sibling tools like emulation and API listing.

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?

Implies usage as a diagnostic check, mentions that WARN is reported instead of ERROR when helper is not found, but lacks explicit when-to-use or when-not-to-use guidance relative to alternatives.

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