lookup_error_code

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

No annotations, but description clearly implies safe read-only lookup behavior. Could add details on return format or performance, but the core behavior is transparent enough for a simple lookup tool.

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?

Two sentences: first states function, second gives usage guidance. No filler, front-loaded with 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?

For a simple lookup with one parameter and no output schema, the description covers purpose, usage context, and parameter format completely.

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 covers the parameter with description and example; description reinforces the example and case-sensitivity. Baseline of 3 since schema coverage is 100% and description adds only marginal extra context.

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 it resolves a FLOX error code to a full Markdown documentation page with specific content (fix recipe, causes, diagnostics). Gives a concrete example and distinguishes from guessing at fixes.

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 to use whenever a FloxError is raised and never to guess from the message alone. Provides clear when-to-use and when-not-to, though does not name alternative tools like docs_search.

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