add_document

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

With no annotations provided, the description carries the burden of disclosing behavior. It discloses that documents are stored locally, encrypted, and strictly validated for known types. This is valuable context beyond the tool's basic purpose, though it omits return behavior and authentication requirements.

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 a concise three-sentence structure that front-loads the primary purpose. Every sentence adds useful information: what it does, how it stores, and validation rules. No fluff or 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?

The description covers the core operation, storage, encryption, and validation, but it lacks details on expected return values, failure behavior, and idempotency. For a create operation with no output schema, these details would be helpful for an agent to confidently invoke the tool.

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 covers 100% of parameters, so the baseline is 3. The description adds meaning beyond the schema by specifying that known document types (passport, national_id, etc.) are strictly validated, which clarifies the semantics of the document_type parameter.

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 explicitly states 'Add a new document to the vault', which is a specific verb+resource action. It clearly distinguishes from sibling tools like update_document and delete_document by emphasizing 'new'.

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?

The description clearly indicates this is for adding new documents, but it does not explicitly state when not to use it (e.g., 'use update_document for existing documents'). The usage context is implied by 'new' but lacks explicit exclusions or alternatives.

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