machship-mcp

Get Special Instructions PDF

machship_get_special_instructions_pdf

Read-onlyIdempotent

Retrieve the special instructions PDF for a consignment, optionally in A4 format, returning the file as base64 with content type and size for inspection or download.

Instructions

Returns the special instructions document PDF for a consignment. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header.

Args:

consignmentId (number): Consignment ID
printA4 (boolean, optional): Print in A4 format

Input Schema

Name	Required	Description	Default
`printA4`	No	Print in A4 format
`consignmentId`	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 / consignmentId / 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

B3.4/5.0

Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and openWorld, so the safety profile is covered. The description adds that contentType originates from the response header, which is genuine extra context, but says nothing about payload size, base64 handling, or error behavior for an unknown consignmentId.

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

Conciseness3/5

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

The first two sentences are front-loaded and earn their place. The Args section, however, duplicates parameter text already fully documented in the schema and could be dropped without loss, making the definition longer than necessary.

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 a full output schema, complete annotations, and 100% parameter coverage, the description is complete enough to call the tool correctly. The only residual gap is that it repeats the return shape already present in the output schema rather than covering error or size-limit behavior.

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%, so the baseline is 3. The description's Args block restates consignmentId and printA4 almost verbatim from the schema, adding no format, range, or default semantics beyond what the structured field already provides.

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 gives a specific verb and resource: returns the special instructions document PDF for a consignment. That is distinct from the many other PDF siblings (label PDF, dangerous goods PDF, MO41 PDF, and the *_pdf_file_info variants). It does not explicitly name a sibling it is not, so it stops 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?

Usage is implied by the purpose: fetch the special-instructions PDF for a given consignment. There is no explicit when-to-use/when-not guidance and no pointer to alternatives such as machship_get_consignment_pdf_file_info or machship_get_consignment_attachments, which an agent choosing among PDF tools would benefit from.

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

Deploy Server