lookup_symbol

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

Describes input handling (case-sensitive, automatic transformations) and output structure (local name, kind, signature, gotchas section). Lacks explicit failure behavior (e.g., symbol not found) but otherwise thorough given no annotations.

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 yet comprehensive; front-loaded with purpose, each sentence provides essential information without redundancy.

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?

Covers return fields and gotchas, adequate for a lookup tool. Lacks precise response format, but given no output schema, this is acceptable.

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 100%, so baseline is 3. The description adds value by explaining automatic prefix transformations for the 'name' parameter and clarifying the 'language' parameter as a filter, improving understanding beyond the 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 the tool resolves a FLOX symbol across all bindings, returning local name, kind, and signature. This differentiates it from sibling tools like lookup_error_code.

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 advises when to use: whenever the user names a struct, function, or indicator, and warns against guessing cross-language spelling. Also explains optional language filter.

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