Skip to main content
Glama
machship-mcp

machship-mcp

Get Consignments by Carrier Consignment ID

machship_get_consignments_by_carrier_id
Read-onlyIdempotent

Finds consignments using carrier tracking IDs, returning matching records for up to 10 IDs per request so you can locate shipments by carrier reference.

Instructions

Finds consignments by carrier's own consignment/tracking ID. Max 10 per request.

Args:

  • carrierConsignmentIds (string[]): Array of carrier consignment IDs (max 10)

Input Schema

NameRequiredDescriptionDefault
carrierConsignmentIdsYesCarrier consignment IDs (max 10)

Output Schema

NameRequiredDescriptionDefault
errorsNoValidation errors returned by Machship, if any
objectNoResponse payload from the Machship API

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.1
    • 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"
      +}
  2. First observedv1.0.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered. The description adds only the batch cap of 10, which is already encoded in the schema via maxItems, so it contributes little new behavioral context beyond noting the batching constraint in prose.

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 purpose and the 10-item cap are front-loaded in the first two sentences. The trailing 'Args:' block largely duplicates the schema, which is mild redundancy but not harmful given the overall brevity.

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?

A single-parameter read tool with a full schema, rich annotations and an output schema needs little prose. The definition covers purpose, lookup key and the batch limit, leaving nothing an agent needs in order 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 description coverage is 100% and the single parameter is fully documented with type, minLength, minItems and maxItems. The description merely restates 'Array of carrier consignment IDs (max 10)', adding no format or syntax detail beyond the schema, which is the expected baseline.

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 ('Finds') and resource ('consignments') and pins the lookup key to the carrier's own consignment/tracking ID, which implicitly differentiates it from siblings like get_consignments_by_ids or get_consignments_by_reference1/2. It stops short of naming those alternatives, but the resource distinction is clear enough to select correctly.

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 'carrier's own consignment/tracking ID' implies the lookup context (you have an external carrier ID, not a Machship ID), but there is no explicit when-to-use/when-not-to-use statement and no named alternative. Usage is inferable rather than guided.

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

Deploy Server

Other Tools