machship-mcp

Get All Consignments

machship_get_all_consignments

Read-onlyIdempotent

Retrieve all consignments for a company with date range, status, carrier, pagination, and child-company filters to review or manage freight shipments.

Instructions

Returns all consignments for a company with date range and status filtering.

Args:

companyId (number): Company ID
startIndex (number, optional): Pagination start index
retrieveSize (number, optional): Number to retrieve
carrierId (number, optional): Filter by carrier
includeChildCompanies (boolean, optional): Include sub-companies
includeDeletedConsignments (boolean, optional): Include deleted
fromDateTimeLocal (string, optional): Start date filter (local time)
toDateTimeLocal (string, optional): End date filter (local time)
filterByEtaCompletedOrDespatch (string, optional): Filter by ETA/despatch status

Input Schema

Name	Required	Description
`carrierId`	No	Filter by carrier ID
`companyId`	Yes	Company ID
`startIndex`	No	Pagination start index (default 1)
`retrieveSize`	No	Number of results to return (default 40, max 200)
`toDateTimeLocal`	No	End date filter (local time ISO 8601)
`fromDateTimeLocal`	No	Start date filter (local time ISO 8601)
`includeChildCompanies`	No	Include consignments from child companies
`includeDeletedConsignments`	No	Include deleted consignments in results
`filterByEtaCompletedOrDespatch`	No	Filter by ETA, completed, or despatch status

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.

Changed10 schema fields changedv1.0.1Nov 3, 2026

addedInput schema / properties / carrierId / description
```
Added value: +"Filter by carrier ID"
```
addedInput schema / properties / carrierId / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / companyId / maximum
```
Added value: +9007199254740991
```
addedInput schema / properties / filterByEtaCompletedOrDespatch / description
```
Added value: +"Filter by ETA, completed, or despatch status"
```
addedInput schema / properties / includeChildCompanies / description
```
Added value: +"Include consignments from child companies"
```
addedInput schema / properties / includeDeletedConsignments / description
```
Added value: +"Include deleted consignments in results"
```

addedInput schema / properties / retrieveSize / description

Added value: +"Number of results to return (default 40, max 200)"

addedInput schema / properties / startIndex / description
```
Added value: +"Pagination start index (default 1)"
```
addedInput schema / properties / startIndex / 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

C2.9/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 covered. The description adds genuine behavioral detail beyond that: pagination, opt-in inclusion of deleted consignments and child companies, and local-time date filtering. It says nothing about result caps, throttling, or how filters combine, which keeps it at adequate rather than strong.

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

Conciseness2/5

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

One useful opening sentence is followed by a nine-line Args block that duplicates a fully documented schema, so a large share of the text does not earn its place. The single piece of genuine routing information is buried in the first line rather than front-loaded as guidance.

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?

An output schema exists, so return values need not be explained. However, for a listing tool with nine parameters and aggressive sibling overlap, the description omits the allowed values for filterByEtaCompletedOrDespatch (no enums in the schema) and gives no basis for choosing this over machship_search_consignments or the specialized consignment getters.

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 baseline is 3. The Args block largely restates the schema and is in places weaker than it (the schema gives defaults 1 and 40, a max of 200, and ISO 8601 format, none of which appear in the description). No added semantics for filterByEtaCompletedOrDespatch, which is a free-form string with no enum.

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: returns all consignments for a company, with date-range and status filtering. It is distinguishable from mutation siblings but not from the many read siblings (machship_search_consignments, machship_get_active_consignments, machship_get_recent_consignments, machship_get_consignments_by_carrier_id), since the description never explains what makes this the 'all' variant versus those.

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 when-to-use guidance, no exclusions, and no named alternatives, despite the sibling list containing at least five closely competing consignment-listing tools. An agent must infer from the name alone that this is the broad/unscoped listing endpoint.

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

Deploy Server