Skip to main content
Glama

rr_add_purchase_order_note

Add a note to a purchase order to record seller context, such as supplier-confirmed lead times, keeping important details attached to the order record.

Instructions

Add a note to a purchase order: context the seller wants kept on the order record (e.g., 'supplier confirmed lead time').

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>",
      "content": "<content>"
    },
    "name": "rr_add_purchase_order_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
po_idYesThe purchase order id or its PO number, for example REV-PO-002 (required).
contentYesThe note text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.3.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already state readOnlyHint=false, destructiveHint=false, idempotentHint=false, and openWorldHint=false, so the mutation profile is covered structurally. The description adds that the note is persisted on the order record, but says nothing about permissions, whether duplicate notes are allowed, or visibility to other users.

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?

A single front-loaded sentence that states the action, the target, and the intent with an illustrative example, with no redundant 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 simple two-parameter append operation with full schema coverage and annotations covering mutability, the description supplies everything needed to call it correctly. Only minor gaps remain, such as permission requirements or behavior on repeated identical notes.

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 description coverage is 100%, with both po_id (including an example PO number) and content documented inline, so the baseline is 3. The description's example note text gives a light sense of expected content but adds little beyond the schema.

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

Purpose4/5

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

The description names a specific verb and resource ('Add a note to a purchase order') and clarifies what the note represents ('context the seller wants kept on the order record'). It does not explicitly differentiate itself from near siblings such as rr_list_purchase_order_notes or rr_add_recommendation_note, so it falls short of a 5.

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

Usage Guidelines3/5

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

The phrase 'context the seller wants kept on the order record' with the example 'supplier confirmed lead time' implies the intended use case (durable annotative info on a PO). However, there is no explicit when-to-use or when-not-to-use guidance and no reference to the related sibling tools for listing or adding notes elsewhere.

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