index_document

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

Describes the full pipeline: reads file, splits into chunks, embeds with nomic-embed-text via Ollama, stores vectors in ChromaDB. Discloses that re-indexing is safe with old chunks replaced. No annotations to contradict; description adds substantial behavioral context.

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?

Extremely concise: two short paragraphs plus Args/Returns section. First sentence immediately communicates purpose. Every sentence adds value with no fluff.

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 purpose, process, parameter constraints, return value, and idempotency. Missing details on error handling or size limits, but output schema exists and tool is simple. Adequate for the context.

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?

Single parameter file_path has no schema description; the description adds absolute path requirement and lists supported file types (.pdf .md .txt .py .js .ts .json .yaml .yml), which is critical for correct invocation.

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 indexes a document into a knowledge base for searchability. Distinguishes from siblings (delete_document, list_indexed_docs, search_docs) by focusing on adding content.

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 context: indexes for search, re-indexing is safe with automatic replacement. Lacks explicit when-not-to-use advice but is sufficiently clear given sibling tools.

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