machship-mcp

Get Consignment by Pending Consignment ID

machship_get_consignment_by_pending_id

Read-onlyIdempotent

Retrieve consignment details using a pending consignment ID that has been linked to a consignment, and confirm whether the resulting shipment record exists.

Instructions

Get consignment details (if it exists) using a pending consignment ID that has been transformed (linked) into a consignment.

Args:

id (number): Pending consignment ID

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "machship_get_consignment_by_pending_id"
  }
}

Input Schema

Name	Required	Description	Default
`id`	Yes	Pending 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.7/5.0

Behavior4/5

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

Annotations already declare readOnly, idempotent, and non-destructive, so safety is covered. The description adds real context beyond them: the pending ID must be in a transformed/linked state, and the result may be absent ('if it exists') — a precondition and outcome caveat an agent could not infer from annotations alone.

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?

One front-loaded sentence captures purpose and precondition. The trailing Args block restates schema content and is mild redundancy, but nothing is padded beyond that.

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-param read tool with a full output schema and rich annotations, the description supplies the key missing piece — the precondition that the pending consignment must be linked — which is what an agent needs to call it correctly.

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 coverage is 100% and the single 'id' parameter is already documented as 'Pending consignment ID' in the schema, so the description's Args block repeats it verbatim. No extra semantics (format, lookup scope) are added, which is the baseline when the schema does the work.

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?

States a specific verb and resource (get consignment details) and adds a meaningful qualifier: the pending ID must already have been transformed/linked into a consignment. This separates it in spirit from machship_get_pending_consignment and machship_get_consignments_by_pending_ids, though it never names those siblings explicitly.

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?

The phrase 'if it exists' implies this tool applies only after a pending consignment has been linked, and suggests a null/absent result otherwise. However, there is no explicit guidance on when to choose this over the sibling pending-consignment or batch-by-pending-ids tools, leaving the routing decision partly to inference.

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

Deploy Server