Skip to main content
Glama

Record which lots shipped on an order (Record plan)

record_shipment
Destructive

Records on a Record account that an order already sent with record_order has shipped, naming the lot each line shipped from, so the order is tied to that lot and its confirmed certificate. The same as POST /v2/orders/{reference}/events with kind shipped (https://provkeep.com/developers). Appended, never overwritten.

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": {
      "code": "<code>",
      "lines": "<lines>"
    },
    "name": "record_shipment"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeYesThe order reference sent with record_order.
linesYes
occurred_atNoWhen it shipped, as an ISO time.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false and destructiveHint=true; the description adds the key behavioral nuance that events are appended and never overwritten, which explains the non-idempotent hint (repeat calls add events). It does not describe the effect on the order's certificate or whether appended events can be removed, but it does not contradict the destructive hint since the order state is still mutated permanently.

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 tight sentences: the action and its effect first, then the API equivalence, then the append constraint. No filler or restated title wording.

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 three-parameter mutation tool with full annotation coverage and no output schema, the description covers the workflow position, the lot-to-line mapping, and append semantics. The remaining gap is what happens to the order's certificate state and error behavior for invalid line_ids, which an agent would benefit from knowing.

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 67%; code and occurred_at already have schema descriptions, and the description reinforces code as the reference sent with record_order. It adds real meaning for lines by clarifying that lot_number identifies the lot the line shipped from, but quantity remains undocumented in both schema and description, and no batch-size or duplicate-line guidance is given.

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?

States a specific verb and resource (records that an order has shipped, with per-line lot attribution) and explicitly ties it to the sibling record_order, which creates the order rather than the shipment event. An agent can distinguish this from record_order and from read tools like get_order without opening the schema.

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

Usage Guidelines4/5

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

Gives clear preconditions: the order must already have been sent with record_order, and this call names the lot each line shipped from. It maps to the equivalent REST endpoint for developers, but offers no explicit exclusions or mention of when to prefer an alternative call.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources