create_reference

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

Discloses that creating a matching reference fulfills any open reference request for that item, which is a behavioral consequence beyond the action. No annotations present, so description carries full burden. Could mention side effects or permissions but still informative.

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?

Three sentences, each serving a purpose: main action, parameter constraints, and side effect. No unnecessary words.

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 presence of an output schema, the description need not detail return values. It covers the tool's role, param values, and consequence (fulfilling requests). Fully adequate for a medium-complexity 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?

With 0% schema coverage, the description adds crucial meaning by specifying allowed values for source_type and target_type. Other parameters (source_id, target_id, status, note) lack detail, but the provided info is highly useful for correct invocation.

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 the tool links a source item to its proof, explains it completes a turnover package, and lists allowed values for source_type and target_type. Distinguishes from sibling create_reference_request by noting it fulfills open requests.

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?

Provides context that this is how a turnover package gets completed and that it fulfills open reference requests, giving implicit guidance on when to use it. No explicit exclusions but sibling tool exists for requests.

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