Skip to main content
Glama
machship-mcp

machship-mcp

Group All Unmanifested Consignments for Manifest

machship_group_all_for_manifest
Read-only

Groups all unmanifested consignments for a company into manifest groups and returns a preview before manifesting, helping verify shipment consolidation prior to final manifest creation.

Instructions

Groups ALL unmanifested consignments for a company into manifest groups (preview before manifesting).

Args:

  • companyId (number): Company ID

Input Schema

NameRequiredDescriptionDefault
companyIdYesCompany ID

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 / companyId / 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.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=true and idempotentHint=false. The description usefully reinforces that the operation is a preview and does not actually manifest anything, resolving the ambiguity of a 'grouping' mutation-looking name. It says nothing about idempotency or what happens on repeat calls, so it adds some but not rich context.

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 efficient, but the trailing Args block duplicates schema information and slightly dilutes an otherwise tight definition.

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?

An output schema exists, so return values need not be explained, and the description covers the scope (all unmanifested consignments for a company) and the preview nature. Minor gap: no note on prerequisites such as consignments being unmanifested or the effect of calling twice.

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 companyId parameter is fully documented in the schema; the description's Args block merely restates it. No additional meaning (e.g. whether companyId must be the authenticated company) is added.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (groups) plus resource (unmanifested consignments), and the emphasis on 'ALL' implicitly separates it from the sibling machship_group_consignments_for_manifest which handles a supplied subset. The added '(preview before manifesting)' clarifies the output is grouping, not actual manifesting.

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 parenthetical indicates this is a pre-manifest preview step, which implies when to call it, but it never names the sibling alternatives (group_consignments_for_manifest, manifest_consignments) or states exclusions such as requiring consignments to be unmanifested first.

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