items-add_documentation

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

With no annotations provided, the description carries full responsibility for behavioral disclosure. It states the action and storage location but omits critical details such as idempotency, error conditions (e.g., invalid item_id), side effects, permissions, or what happens to existing documentation. This lack of behavioral context could lead to misuse.

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 extremely concise, consisting of two sentences that front-load the primary purpose and add relevant context about the CMMN pattern and storage location. Every word contributes value, and there is no redundancy or fluff.

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 the lack of annotations and output schema, the description should cover return values, confirmation of success, or potential errors. It does not mention what the tool returns or whether the addition is immediately persisted. For a mutation tool with three parameters, this omission leaves agents without critical context for interpreting results.

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 100%, meaning each parameter already has a clear description in the schema. The description adds minimal extra meaning beyond 'text' and 'text_format' being part of a documentation entry. While it mentions storage in an array, it does not elaborate on parameter constraints or formats beyond the schema's baseline, so a score of 3 is appropriate.

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 adds a documentation entry to a CaseFileItem, specifies the storage location (data.documentation array), and references the CMMN tCmmnElement pattern. It distinguishes itself from siblings like cases-add_documentation (which targets cases) and items-remove/list_documentation by focusing on addition to a specific item.

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 implies use when needing to add documentation to a Case File Item but provides no explicit guidance on when to use this tool versus alternatives such as cases-add_documentation. It does not mention when not to use it or any prerequisites, leaving the agent to infer context from the tool name alone.

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