lookup_doc

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

Discloses key behaviors: FTS over local index only, no PDF indexing, returns chunks vs suggestedDocuments, and that maxDocsToIndex is ignored. No annotations provided, so description carries full burden and fulfills it well.

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, using bold for emphasis and a logical flow. Every sentence adds value 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?

Fully contextualizes the tool for an AI agent: explains behavior, limitations, next steps, and references a resource guide. No output schema or annotations, but description compensates 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?

Adds meaning beyond schema: specifies vendor values, explains part revision normalization, clarifies question usage, and indicates maxDocsToIndex is legacy/ignored. Schema coverage is 100%, but description provides crucial additional 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?

The description clearly states it performs full-text search over a local index for part numbers and questions, distinguishing it from sibling tools by explicitly noting it does not download or index PDFs.

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?

Provides explicit when-to-use and when-not-to-use guidance, including next steps (read_doc, query_doc_content) and mentions a known limitation (TI symlink datasheets may be missing from suggestions).

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