Skip to main content
Glama
machship-mcp

machship-mcp

Get Pending Consignments by IDs (Batch)

machship_get_pending_consignments_by_ids
Read-onlyIdempotent

Retrieves details for up to 10 pending consignments by ID so you can review and process shipments in a single request.

Instructions

Returns details for multiple pending consignments by IDs (max 10 per request).

Args:

  • ids (number[]): Pending consignment IDs (max 10)

Input Schema

NameRequiredDescriptionDefault
idsYesPending 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. 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

B3.4/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety and side-effect profile is fully covered without the description. The description adds only the 'max 10 per request' batch cap, which is already encoded as maxItems=10 in the schema; it says nothing about partial results, missing/invalid IDs, or ordering.

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 sentence is front-loaded and short, with no wasted prose. The trailing 'Args:' block is largely redundant with the schema and slightly inflates the definition, but overall it is tight.

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?

With one required parameter at full schema coverage, an output schema present, and annotations covering read-only/idempotent behavior, an agent has everything needed to invoke this correctly. The description does not need to explain return values or pagination here.

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 there is only one parameter, whose type, minimum, and maxItems are all declared in the schema. The description's 'ids (number[]): Pending consignment IDs (max 10)' restates the schema verbatim without adding format or selection meaning, so the baseline 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 states a specific verb and resource — returns details for multiple pending consignments by ID — so an agent can tell this is a batched ID lookup rather than a single fetch (machship_get_pending_consignment) or a reference search. It does not explicitly name those siblings, which keeps it from a 5.

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 word 'multiple' hints at batching, but the description never says to prefer machship_get_pending_consignment for a single ID or machship_get_pending_consignments_by_reference1/2 when only references are known, leaving the agent to infer routing from the tool name alone.

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