Skip to main content
Glama

rr_record_proforma_invoice

Destructive

Records a supplier's proforma invoice on a purchase order, capturing PI number, date, total and payment terms. Moves sent or confirmed orders to pi_received and updates existing PI details.

Instructions

Record a supplier's proforma invoice (PI) on a purchase order: its number, date, total and payment terms. A sent or confirmed order moves to pi_received; one already at pi_received has its PI details updated; any other status is refused. Send only the fields the seller gave you.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "po_id": "<po_id>"
    },
    "name": "rr_record_proforma_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
po_idYesThe purchase order id or its PO number, for example REV-PO-002.
pi_dateNoThe invoice date, ISO 8601, for example 2026-10-18.
pi_termsNoThe payment terms as a JSON object under 4 KB, for example {"deposit_pct": 30, "balance": "on shipment"}.
pi_totalNoThe invoice total.
pi_numberNoThe proforma invoice number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.3.1

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the destructive/not-idempotent annotations, the description discloses the state transition and the update behavior for existing PI data, plus a caution to send only supplied fields. It stops short of explaining exactly what prior PI data may be overwritten or any permission requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences: purpose first, state behavior second, input caution third. There is no filler, and each sentence contributes to correct invocation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive mutation with five parameters and no output schema, the description covers purpose, allowed statuses, update behavior, and input discipline. It leaves some detail unstated, notably what the response contains and whether an existing PI is merged or replaced.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the parameter descriptions already define po_id, dates, terms, total, and number. The description only restates the field list and adds a generic input caution, which does not add format or constraint meaning beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource ('Record a supplier's proforma invoice ... on a purchase order') and enumerates the PI fields involved, making the operation distinct from generic purchase-order tools. It is immediately clear what business object is being written.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit state gating: sent or confirmed orders move to pi_received, orders already at pi_received are updated, and any other status is refused. That is clear when-to-use and when-not-to-use guidance, even without naming an alternative tool.

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