ingest_file

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

Without annotations, description discloses important behavior: overwrites existing data on re-ingest, and lists return fields. This goes beyond the schema by revealing the destructive replacement semantics.

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 convey purpose, constraints, and return format without waste. Front-loaded with the verb and resource.

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 tool with three params and no output schema, the description covers return value and replacement behavior. Could mention when to prefer this over ingest_data, but overall sufficient.

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 already documents all parameters with 100% coverage, so the description doesn't need to add. It does reiterate absolute path but adds no new semantics beyond 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?

Description clearly states the action (ingest), the resource (document file into vector database), and supported formats (PDF, DOCX, TXT, MD), which distinguishes it from siblings like ingest_data and query_documents.

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 context: absolute path required and re-ingesting replaces existing data. Does not explicitly mention when to use vs alternatives like ingest_data, so not a 5.

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