rr_record_pi_review

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

No annotations provided, so the description must bear the full burden. It indicates mutation ('Record') but does not disclose idempotency, side effects (e.g., overwriting existing PI details), required permissions, or return behavior. For a write tool, this is insufficient.

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, well-structured sentence that front-loads the verb and resource. No unnecessary words; every word earns its place. It is as concise as possible while remaining clear.

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?

Despite 5 parameters and no output schema, the description is minimal. It does not explain when or why to call this tool, what the response indicates (e.g., confirmation, error), or how it fits into the larger workflow. More detail is needed for an AI to use it correctly.

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%, so baseline is 3. The description lists the fields that correspond to parameters but adds no additional meaning beyond the schema descriptions. It reinforces the context but does not deepen understanding.

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 specific action ('Record') and resource ('proforma invoice details on a purchase order'), and lists the key fields (PI number, date, total, terms). It distinguishes itself from sibling tools like 'rr_get_purchase_order' which are read-related.

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. It does not mention prerequisites (e.g., the purchase order must exist) or when not to use it (e.g., if the PI already exists). The context 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.