machship-mcp

Get Consignment Notes

machship_get_consignment_notes

Read-onlyIdempotent

Retrieve all notes attached to a Machship consignment by ID, including internal comments and delivery instructions, to review shipment details and special handling requirements.

Instructions

Returns all notes attached to a consignment (internal comments, delivery instructions, etc.).

Args:

id (number): Consignment ID

Input Schema

Name	Required	Description	Default
`id`	Yes	Consignment ID

Output Schema

Name	Required	Description	Default
`errors`	No	Validation errors returned by Machship, if any
`object`	No	Response payload from the Machship API

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv1.0.1Nov 3, 2026

addedInput schema / properties / id / maximum
```
Added value: +9007199254740991
```

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": {},
+  "properties": {
+    "errors": {
+      "anyOf": [
+        {
+          "items": {},
+          "type": "array"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "description": "Validation errors returned by Machship, if any"
+    },
+    "object": {
+      "description": "Response payload from the Machship API"
+    }
+  },
+  "type": "object"
+}

First observedv1.0.0Jun 12, 2026

TDQS

A3.5/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is fully covered elsewhere. The description adds useful context about the nature of the returned content, but says nothing about volume, ordering, or what happens when a consignment has zero notes, and an output schema already covers the return shape.

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

Conciseness4/5

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

The core sentence is front-loaded and wastes no words. The appended Args block is redundant with the schema but is short enough not to hurt readability.

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?

With one required parameter, full schema coverage, rich annotations, and an output schema, the description covers what an agent needs to invoke the tool correctly. The only meaningful omission is any routing guidance versus the many consignment-related siblings.

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% and the single parameter already documents itself as "Consignment ID" with type and bounds. The description's Args block simply restates that, adding no new meaning such as where to obtain the ID or whether pending consignment IDs are accepted.

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 ("Returns all notes attached to a consignment") and clarifies what counts as a note (internal comments, delivery instructions). It does not, however, differentiate itself from nearby siblings such as machship_get_consignment_attachments or machship_get_special_instructions_pdf, which an agent could easily confuse with this one.

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?

Usage is only implied: an agent can infer it should call this when it needs commentary attached to a known consignment ID. There is no explicit statement of when to prefer this over machship_get_consignment or the attachment/instruction tools, and no prerequisites or exclusions are given.

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

Deploy Server