Skip to main content
Glama
Sign In
machship-mcp

machship-mcp

by devkindhq
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get Dangerous Goods Document PDF File Info

machship_get_dangerous_goods_pdf_file_info
Read-onlyIdempotent

Retrieve a consignment's dangerous goods declaration PDF as JSON, including base64 content, file name, and content type.

Instructions

Returns the dangerous goods declaration PDF as JSON. object.content holds the file as base64, with object.fileName and object.contentType.

Args:

  • consignmentId (number): Consignment ID

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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so safety is covered. The description adds the practically useful detail that the payload is base64-encoded content plus fileName/contentType, but since an output schema exists this is largely return-shape repetition rather than new behavioral context such as size limits or error behavior for consignments without DG items.

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, front-loaded passages with the key payload fact first. The Args block is redundant with the schema but is compact enough not to waste much space.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter read tool with full annotations and an output schema, the description is adequate about what comes back, but it omits the one thing an agent needs to choose correctly: the relationship to machship_get_dangerous_goods_pdf and the other PDF file-info tools.

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?

With a single parameter at 100% schema description coverage, the schema already fully documents consignmentId. The description's 'consignmentId (number): Consignment ID' restates the schema verbatim and adds no meaning, so 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?

States a specific verb and resource ('Returns the dangerous goods declaration PDF as JSON') and describes the payload shape (object.content base64, object.fileName, object.contentType). It implicitly differentiates from machship_get_dangerous_goods_pdf by emphasizing the JSON/file-info form, but never names that sibling explicitly, so the contrast must be inferred from the tool name.

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: the description makes clear this is for retrieving the DG declaration as a JSON file object, but it never says when to pick this over machship_get_dangerous_goods_pdf or the other *_pdf_file_info siblings, nor any prerequisites (e.g. consignment must have dangerous goods declared).

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