pay_document

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

With no annotations, the description should disclose effects such as document status updates or idempotency. It only says 'register a payment,' omitting crucial behavioral details like whether duplicate payments are allowed or what side effects occur.

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 single sentence, which is concise, but it sacrifices informativeness. A bit more structure (e.g., stating the tool registers a payment against a specific document) would improve clarity without adding much length.

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 payment registration tool with 5 parameters and no output schema, the description is insufficient. It lacks details on return values, error conditions, prerequisites (e.g., document must exist), and effects on the document's payment status.

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?

All parameters have schema descriptions (100% coverage), so the description adds minimal value. It does not clarify the meaning of 'treasuryId' or 'date' beyond the schema's basic descriptions.

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 registers a payment for a document, with a specific verb and resource. However, it does not differentiate from the sibling 'create_payment' which might also record payments but without tying to a document.

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?

No guidance on when to use this tool versus alternatives like 'create_payment' or when to avoid it. The context for payment registration is implied but not explicit.

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