reingest_document_tool

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

No annotations are provided, so the description must carry full burden. It mentions 'Force re-index' but does not disclose side effects, permissions required, whether the operation is synchronous or asynchronous, or what happens to existing data. This is insufficient for a mutation 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?

The description is three sentences, each serving a distinct purpose: stating the core action, specifying valid usage contexts, and prohibiting misuse. No redundant 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?

The tool has an output schema, so return values are presumably defined there. However, the description does not mention that the document must already exist, or that re-ingestion might affect other processes. It references sibling tool set_document_type but doesn't fully integrate context. Adequate but not thorough.

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?

The schema has a single required parameter 'document' with no description (0% schema description coverage). The tool description also does not explain what format or identifier is expected (e.g., filename, path, or ID). This leaves the agent guessing.

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's purpose: 'Force re-index of a PDF in this server's corpus.' It uses a specific verb and resource, distinguishing it from siblings like get_document_profile_tool or list_documents_tool.

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 states when to use: 'when the user explicitly requests re-ingest, after PDF file changes, or after set_document_type with reingest.' Also provides exclusions: 'Not for routine queries. Do not use proactively or for code/build tasks.'

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