rr_record_pi_review

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

With no annotations, the description alone must disclose behavioral traits. It only states the action 'record', implying mutation, but provides no details on side effects, idempotency, required permissions, or whether it updates an existing PO or creates a new record.

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 6-word sentence, which is concise but lacks structure. It conveys the core purpose but omits important details that could be organized, such as parameter explanations or usage conditions.

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 complexity (5 parameters, no output schema, no annotations), the description is too brief. It does not cover return values, prerequisites, related tools, or how this action interacts with the underlying PO record.

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 5 parameters with 0% coverage. The description does not explain the meaning or format of pi_number, pi_date, pi_total, or pi_terms. It fails to compensate for the lack of schema 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 'Record proforma invoice details on a PO' clearly identifies the action (record) and the resource (proforma invoice details on a PO). It is specific but does not distinguish it from sibling tools like rr_add_po_note or rr_update_purchase_order, which might also record details.

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 usage guidelines are provided. The description does not indicate when to use this tool versus alternatives, nor does it mention prerequisites or exclusions. The context signals suggest many sibling tools, but no comparison is offered.

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