Skip to main content
Glama
machship-mcp

machship-mcp

Get Unmanifested Consignments

machship_get_unmanifested_consignments
Read-onlyIdempotent

Retrieves consignments created but not yet manifested with a carrier, helping identify shipments awaiting booking and filter by company, carrier, or sub-companies.

Instructions

Returns consignments that have been created but not yet manifested (booked with carrier).

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

Input Schema

NameRequiredDescriptionDefault
carrierIdNoFilter by carrier ID
companyIdYesCompany ID
startIndexNoPagination start index
retrieveSizeNoItems to retrieve
includeChildCompaniesNoInclude child companies

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. Changed4 schema fields changedv1.0.1
    • addedInput schema / properties / carrierId / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / companyId / maximum
      Added value: +9007199254740991
    • 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"
      +}
  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, non-destructive and openWorld, so the safety profile is covered. The description adds the domain meaning of 'unmanifested' and the pagination parameters, but says nothing about ordering, total counts, or behaviour when no consignments are pending — and an output schema exists, so return-shape detail is not required.

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 first sentence is front-loaded and precise, and the Args list is scannable. The Args block duplicates what the schema already says, so it is mild padding rather than wasted prose overall.

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?

With a full input schema, a rich annotation set, and an output schema, the definition supplies the one thing structured data cannot: what 'unmanifested' means in this domain. The only gap is disambiguation from machship_get_unmanifested_consignment_for_edit.

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 the schema already documents all five parameters, including defaults (startIndex=1, retrieveSize=40) and bounds (retrieveSize max 200) that the description omits. The Args block largely restates the schema with less precision, so it adds no meaning beyond the structured fields — baseline 3.

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 gives a specific verb and resource plus a domain-defining qualifier: consignments 'created but not yet manifested (booked with carrier)', which meaningfully separates it from generic siblings like machship_get_all_consignments or machship_get_active_consignments. It stops short of naming the nearest sibling, machship_get_unmanifested_consignment_for_edit, so an agent must still infer which of the two 'unmanifested' tools fits.

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 implied by the state filter ('not yet manifested'), so an agent can reason that this is the tool for finding shipments awaiting booking. However, there is no explicit when-to-use/when-not-to-use guidance, no mention of prerequisites such as needing a manifest workflow next, and no reference to the near-identical _for_edit sibling.

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