Skip to main content
Glama

Linnworks MCP by usefulapi

Get order notes

linnworks_get_order_notes
Read-only

The notes on an order (text, internal or external, who wrote them and when). GET /api/Orders/GetOrderNotes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
order_idYesThe order id (OrderId / pkOrderId).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds useful content-level context about what a note record contains (text, visibility scope, author, timestamp), but says nothing about ordering, result limits, or empty-note behavior.

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?

Two short sentences: the return content first, then the backing endpoint. Nothing is wasted and the payload description is front-loaded.

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 single-parameter read tool with full schema coverage and annotations carrying the safety profile, the definition is largely sufficient. It does not address result ordering or whether an order with no notes returns an empty list, which is a minor remaining gap.

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 a single order_id parameter whose UUID pattern and OrderId/pkOrderId mapping are fully documented in the schema. The description adds no parameter detail beyond that, so the baseline 3 applies.

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 the resource (order notes) and enumerates the fields returned (text, internal/external, author, timestamp), which is more specific than the tool name alone. It implies read semantics and is distinguishable from the sibling linnworks_add_order_note, though that sibling is never named explicitly.

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

Usage Guidelines2/5

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

There is no guidance on when to call this versus alternatives — notably linnworks_add_order_note for writing notes, or linnworks_get_order for a broader order view. The agent must infer the retrieval use case entirely from the name.

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.