machship-mcp

Get Consignment

machship_get_consignment

Read-onlyIdempotent

Fetch complete details for a single consignment by ID, optionally including deleted records or request GUIDs. Use it to verify shipment information for tracking, updates, or troubleshooting.

Instructions

Returns full details for a single consignment by ID.

Args:

id (number): Consignment ID
includeDeleted (boolean, optional): Include deleted consignments
includeRequestGuids (boolean, optional): Include request GUIDs in response

Input Schema

Name	Required	Description
`id`	Yes	Consignment ID
`includeDeleted`	No	Include deleted consignments
`includeRequestGuids`	No	Include request GUIDs

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

B3.2/5.0

Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds useful context that deleted consignments exist and are excluded unless includeDeleted is set, plus that request GUIDs are optional response fields. It says nothing about behavior when the ID is unknown or about the scope of 'full details'.

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 purpose sentence is front-loaded and the whole definition is two short blocks with no filler. The 'Args' list duplicates the input schema, which is mild redundancy but does not bloat the text.

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

Completeness3/5

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

With a full output schema and rich annotations, the description need not explain return values, and the parameters are fully covered. However, for a single-record lookup among many consignment getters, it omits the routing information (which sibling to use for multiple IDs, references, or searches) that would make the definition self-sufficient.

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 schema already documents all three parameters. The 'Args' block largely restates those schema descriptions verbatim ('Consignment ID', 'Include deleted consignments'), with only a small addition ('in response' for request GUIDs). This is baseline-3 territory: accurate but not additive.

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 states a specific verb and resource ('Returns full details for a single consignment by ID'), so an agent knows exactly what the tool fetches. It does not distinguish itself from close siblings such as machship_get_consignments_by_ids, machship_search_consignments, or machship_get_consignment_for_clone, which an agent could easily confuse it with.

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 explicit when-to-use or when-not-to-use guidance. The phrase 'by ID' implicitly signals that a consignment ID is required, but nothing says when to pick this over the batch lookup, the search tool, or the clone-specific getter.

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

Deploy Server