Skip to main content
Glama
Sign In
machship-mcp

machship-mcp

by devkindhq
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get MO41 Document PDF File Info

machship_get_mo41_document_pdf_file_info
Read-onlyIdempotent

Retrieve a consignment's MO41 document as a PDF file encoded in JSON, returning base64 content, file name, and content type for further processing.

Instructions

Returns the MO41 document PDF as JSON. object.content holds the file as base64, with object.fileName and object.contentType.

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

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

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

Annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so safety needs no restating. The description adds real behavioral context beyond that: the response is JSON with base64 content plus fileName and contentType, which tells an agent it must decode before use. It stops short of noting size limits or error behavior for an invalid consignment.

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?

Two short blocks, front-loaded with the return shape and followed by a minimal Args list. The Args entry duplicates the schema verbatim and could be dropped, but there is no padding or filler.

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 and the description still usefully summarizes the payload fields, so an agent knows what to expect. For a single-parameter read tool the definition is nearly sufficient; the only real gap is the absence of disambiguation from the sibling get_mo41_document_pdf.

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 description coverage ('Consignment ID'), and the Args block merely restates it. No added meaning such as whether the consignment must exist or be manifested is provided, which is the correct baseline for a fully documented one-param schema.

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?

States a specific verb and resource ('Returns the MO41 document PDF') and clarifies that the result is JSON rather than raw bytes. It does not explicitly distinguish itself from the sibling machship_get_mo41_document_pdf, which is the obvious ambiguity an agent would face.

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 description implies usage by disclosing that the payload is a base64-encoded JSON envelope, but it never says when to prefer this over machship_get_mo41_document_pdf or the other *_pdf_file_info tools. The choice is left to inference from the return shape.

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