Skip to main content
Glama

Linnworks MCP by usefulapi

Add order note

linnworks_add_order_note
Destructive

WRITE: add a note to an order (open or processed). Internal notes are visible only inside Linnworks; external notes may be passed to the sales channel. Adds a new note each call (not idempotent). POST /api/Orders/AddOrdersNote.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteYesThe note text.
internalNoInternal note (default true).
order_idYesThe order id (OrderId / pkOrderId).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly=false, idempotent=false, and destructive=true. The description adds meaningful context beyond those: internal notes stay inside Linnworks while external notes may reach the sales channel, and it clarifies that each call appends a new note rather than updating one. It does not explain permission requirements or why destructiveHint is true, keeping it from a 5.

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?

One tightly packed sentence front-loads the WRITE nature, then covers scope, note visibility, idempotency behavior, and the HTTP endpoint without any wasted words.

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

Completeness5/5

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

For a simple three-parameter write tool with full schema coverage, annotations covering safety, and no output schema, the description supplies everything an agent needs: purpose, scope, side effects, idempotency, and endpoint. No critical behavioral detail is missing.

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

Parameters4/5

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

Schema description coverage is 100%, so the schema documents all three parameters including the order_id UUID pattern and note length limits. The description adds semantic meaning for the 'internal' parameter by explaining that internal notes are visible only inside Linnworks while external notes may be passed to the sales channel.

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 ('add a note to an order') with scope ('open or processed') and distinguishes itself from the sibling retrieval tool get_order_notes. An agent can identify the operation 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?

Provides clear context for when the tool applies (open or processed orders) and explains the internal vs external note distinction, but does not name alternatives or state when not to use it. No sibling add-note alternative exists, so routing guidance is not needed.

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.