Skip to main content
Glama
machship-mcp

machship-mcp

Edit Unmanifested Consignment

machship_edit_consignment

Edit an existing unmanifested consignment before it is booked; manifested consignments cannot be changed.

Instructions

Edits an existing unmanifested (not yet booked) consignment. Cannot edit manifested consignments.

Args:

  • consignment (object): Updated consignment data including the 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": {
      "consignment": "<consignment>"
    },
    "name": "machship_edit_consignment"
  }
}

Input Schema

NameRequiredDescriptionDefault
consignmentYesUpdated consignment data including 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 / consignment / propertyNames
      Added value: +{
      +  "type": "string"
      +}
    • 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 non-read-only, non-idempotent, non-destructive, open-world behavior. The description adds the useful manifested/unmanifested precondition, but says nothing about whether the update is full-replacement or partial, what happens to omitted fields, or permission requirements — relevant since destructiveHint=false could mislead an agent into assuming omitted data survives.

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 front-loaded sentences convey the operation and the key constraint with no padding. The trailing Args block merely restates the schema's own property description, which is minor waste but not harmful.

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

Completeness2/5

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

This is a mutation on an untyped nested object, and the description gives no guidance on how to construct the payload — no pointer to fetching the existing consignment for edit, no field list, no partial-vs-full semantics. Given the completely opaque nested schema, the description should carry far more weight than it does.

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 nominally 100%, but the single 'consignment' parameter is a free-form object with additionalProperties {} and no field structure, so the schema conveys almost nothing. The description only repeats 'updated consignment data including the consignment id' and adds no indication of expected fields, ID type, or nested shapes.

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 (edits) and a precisely scoped resource (an existing unmanifested consignment), and clarifies 'unmanifested' as 'not yet booked'. It does not name any of the many related siblings (update_reprice_consignment, update_consignment_statuses, get_unmanifested_consignment_for_edit), so differentiation still relies on inference from the name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides a genuine exclusion — manifested consignments cannot be edited — which tells the agent when this call will fail. It stops short of routing the agent anywhere for the manifested case or suggesting the sibling used to fetch editable consignment data first (get_unmanifested_consignment_for_edit).

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