Skip to main content
Glama
machship-mcp

machship-mcp

Get Consignments by IDs (Batch)

machship_get_consignments_by_ids
Read-onlyIdempotent

Retrieve details for up to 100 consignments by their IDs in one request, so you can look up multiple shipments without querying each one separately.

Instructions

Returns details for multiple consignments by their IDs (max 100 per request).

Args:

  • ids (number[]): Array of consignment IDs (max 100)

Input Schema

NameRequiredDescriptionDefault
idsYesConsignment IDs (max 100)

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. Changed2 schema fields changedv1.0.1
    • addedInput schema / properties / ids / items / 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"
      +}
  2. First observedv1.0.0

TDQS

A3.6/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 fully covered. The description adds only the batch size ceiling, which is also in the schema, and says nothing about partial results (what happens when some IDs don't exist) or request throttling.

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 statement is one front-loaded sentence with no wasted prose. The trailing 'Args:' block largely restates the schema entry for the single parameter, which is mild redundancy but not harmful.

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

Completeness5/5

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

For a single-parameter, read-only batch fetch with a full output schema and complete annotations, nothing essential is missing. The one behavioral fact an agent needs beyond structured fields — the per-request cap — is stated up front.

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 both the type (integer array, positive, maxItems 100, minItems 1) and the meaning of 'ids' are already documented. The description repeats the same 'max 100' note without adding format, ordering, or ID-source guidance, so baseline 3 applies.

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 uses a specific verb and resource ('Returns details for multiple consignments by their IDs') and signals batch scope, which separates it from single-record siblings like machship_get_consignment. It does not, however, explicitly distinguish itself from the other lookup siblings (by_reference1/2, by_carrier_id, search_consignments), so the agent must infer the boundary.

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 only implied: 'multiple ... by their IDs' hints at batch lookup when IDs are already known, and the max-100 constraint scopes it. There is no explicit when-to-use/when-not guidance or named alternative for reference-based, carrier-based, or free-text searches.

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