register_document

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

Discloses output format, warns not to pass credentials, and explains source format specifics. With no annotations, it provides good behavioral context, though could mention error handling or idempotency.

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?

Appropriately sized with front-loaded action and return info. Includes examples and warning, no unnecessary fluff, though could be slightly more compact.

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, parameter semantics for source, output format, and a safety note. Missing error behavior and connectionId details, but sufficient for a simple registration tool with two parameters.

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 coverage is 0%, but description explains 'source' parameter in detail with examples. 'connectionId' is not described beyond being a connection identifier, leaving some ambiguity.

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 it registers a document and returns a documentId. Explains source formats for different connections, distinguishing it from sibling tools like find_in_document or list_connections.

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?

Implied usage (registering a document) but no explicit when-to-use vs alternatives or prerequisites. Sibling tools are different enough that context is clear, but lacks direct guidance.

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