Skip to main content
Glama
Sign In
machship-mcp

machship-mcp

by devkindhq
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get Item Label PDF File Info

machship_get_item_pdf_file_info
Read-onlyIdempotent

Retrieve a consignment item/package label PDF as JSON, including base64 content, fileName, and contentType, with optional A4 formatting.

Instructions

Returns the item/package label PDF as JSON. object.content holds the file as base64, with object.fileName and object.contentType.

Args:

  • consignmentId (number): Consignment ID

  • printA4 (boolean, optional): Whether the label is in A4 format

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_item_pdf_file_info"
  }
}

Input Schema

NameRequiredDescriptionDefault
printA4NoA4 format flag
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.7/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, openWorld, and non-destructive, so the safety profile is covered. The description adds genuine behavioral value beyond that by disclosing the response contract: base64 content in object.content with fileName and contentType. It stops short of saying whether one label or multiple item labels come back for a consignment, and says nothing about payload size.

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 return-shape sentence is front-loaded and high value, and the whole description is short. The Args list duplicates structured schema data and could be dropped without loss, which keeps it from a 5.

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 two-parameter read tool with full schema coverage and an output schema, the description covers what an agent needs to call it and interpret the payload. The remaining gap is disambiguation from the many adjacent label/PDF tools in the sibling list.

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 coverage is 100%, so both parameters are already documented in the schema; the description's Args block largely restates them. The only small addition is clarifying printA4 as 'whether the label is in A4 format,' which is marginally more informative than the schema's 'A4 format flag'.

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 item/package label PDF as JSON' — and immediately clarifies the payload shape (base64 in object.content plus fileName/contentType). The 'as JSON' framing hints at the distinction from raw-PDF siblings like machship_get_item_label_pdf, but no sibling is named explicitly.

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 by the return-format framing: an agent can infer this is the variant to call when it wants file metadata/base64 rather than a binary stream or a zip bundle. There is no explicit statement of when to choose this over machship_get_item_label_pdf, machship_get_item_labels_zip, or machship_return_item_pdfs_for_consignments.

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