Skip to main content
Glama
Sign In
machship-mcp

machship-mcp

by devkindhq
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get Manifest Label PDF by Consignment

machship_get_manifest_label_pdf_by_consignment
Read-onlyIdempotent

Fetches the manifest PDF for a given consignment ID, returning base64-encoded file data, content type, and size for download or processing.

Instructions

Returns the manifest PDF for the manifest associated with a given consignment. Returns { fileBase64, contentType, sizeBytes }. contentType comes from the response header.

Args:

  • consignmentId (number): Consignment ID

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "consignmentId": "<consignmentId>"
    },
    "name": "machship_get_manifest_label_pdf_by_consignment"
  }
}

Input Schema

NameRequiredDescriptionDefault
consignmentIdYesConsignment 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 / consignmentId / 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 readOnly, idempotent, non-destructive, openWorld, so the safety profile is covered. The description adds that contentType is taken from the response header, which is genuinely useful beyond the schema, but it omits the important failure mode: what happens if the consignment is not yet manifested and therefore has no manifest PDF, and whether this returns an error or empty payload.

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 purpose and return shape are front-loaded in the first two sentences, and the description is short with no filler. The trailing Args block duplicates the schema and could be dropped, which is the only waste.

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?

For a one-parameter read tool with an output schema, the description covers purpose, scoping, and response fields adequately. The remaining gap is the pre-condition/failure case (consignment must be manifested) and disambiguation from the manifest-ID sibling, both of which an agent would benefit from.

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?

There is a single required parameter with 100% schema coverage, so the schema already fully documents consignmentId (integer, positive). The 'Args' block merely restates 'Consignment ID' without adding format, sourcing, or validation meaning; 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 states a specific verb and resource (returns the manifest PDF) and, crucially, the access path: the manifest 'associated with a given consignment' rather than a manifest ID. That implicitly separates it from siblings like machship_get_manifest_label_pdf, but no sibling is named explicitly, so the differentiation requires the agent to infer the lookup key difference.

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 'associated with a given consignment' phrasing — use this when you have a consignment ID and not a manifest ID. There is no explicit when-to-use, when-not-to-use, or named alternative (e.g. machship_get_manifest_label_pdf or machship_get_manifest_pdf_file_info for metadata-only), so the agent must infer routing.

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