Post document

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

The description mentions 'locking it', implying the document becomes immutable, which is a behavioral trait. However, it does not disclose side effects, validation checks, or permission requirements. Annotations are absent, so the description carries the full burden, but it only partially fulfills it.

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?

One sentence, very concise and to the point. However, it could include brief parameter descriptions without becoming verbose.

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?

Given no output schema, 4 undocumented parameters, and extensive sibling tools, the description is incomplete. It does not explain what the tool returns or any prerequisites for posting a document.

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 input schema has 4 parameters with 0% description coverage, yet the tool description adds no information about parameters (e.g., what 'kind', 'id', 'company', 'profile' mean). The description fails to compensate for the schema gap.

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 finalizes a supported accounting document by locking it, which is a specific verb-resource pair. It does not explicitly differentiate from siblings like 'validate_document' or 'create_document_draft', but the term 'post' is domain-specific enough.

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 (e.g., validate_document, update_document_header). No prerequisites or exclusions mentioned, leaving the agent to infer usage from the description alone.

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