Skip to main content
Glama
machship-mcp

machship-mcp

Get Recently Created/Updated Pending Consignments

machship_get_recent_pending_consignments
Read-onlyIdempotent

Retrieve pending consignments created or updated within a UTC date range to support sync workflows and keep shipment records current.

Instructions

Returns pending consignments created or updated within a UTC date range. Useful for sync workflows.

Args:

  • companyId (number): Company ID

  • fromDateUtc (string): Start datetime UTC (ISO 8601)

  • toDateUtc (string): End datetime UTC (ISO 8601)

  • startIndex (number, optional): Pagination start

  • retrieveSize (number, optional): Page size

  • carrierId (number, optional): Filter by carrier

  • includeChildCompanies (boolean, optional): Include sub-companies

  • getDeleted (boolean, optional): Include deleted pending consignments

Input Schema

NameRequiredDescriptionDefault
carrierIdNoFilter by carrier ID
companyIdYesCompany ID
toDateUtcYesEnd datetime UTC (ISO 8601)
getDeletedNoInclude deleted pending consignments
startIndexNoPagination start index
fromDateUtcYesStart datetime UTC (ISO 8601)
retrieveSizeNoNumber of results to return (max 200)
includeChildCompaniesNoInclude pending consignments from child companies

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. Changed9 schema fields changedv1.0.1
    • addedInput schema / properties / carrierId / description
      Added value: +"Filter by carrier ID"
    • addedInput schema / properties / carrierId / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / companyId / maximum
      Added value: +9007199254740991
    • addedInput schema / properties / getDeleted / description
      Added value: +"Include deleted pending consignments"
    • addedInput schema / properties / includeChildCompanies / description
      Added value: +"Include pending consignments from child companies"
    • addedInput schema / properties / retrieveSize / description
      Added value: +"Number of results to return (max 200)"
    • addedInput schema / properties / startIndex / description
      Added value: +"Pagination start index"
    • addedInput schema / properties / startIndex / 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.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is fully covered by structured data and the description adds little there. The text does contribute some behavioral context beyond annotations: results are delimited by UTC date bounds on creation/update, deleted records are excluded unless getDeleted is set, and paging is via startIndex/retrieveSize. It says nothing about volume, ordering, or the max-200 cap implications, so it remains mid-range.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The opening two sentences are well front-loaded and earn their place, but the eight-line Args enumeration is redundant duplication of a schema that is already 100% documented and in places less precise than the schema. Trimming that block would drop the description from a bulky listing to a tight, purposeful one.

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?

With a full output schema, rich annotations, and complete schema descriptions, the burden on the description is low, and the essentials (resource, date-range scope, sync use case) are present. Gaps remain around ordering, the practical effect of the 200 page cap, and which sibling to use for non-date-based retrieval, but none of these are blocking for correct invocation.

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 description coverage is 100%, so the schema already documents every one of the eight parameters, making 3 the baseline. The Args block in the description largely restates the schema wording verbatim (e.g. 'End datetime UTC (ISO 8601)', 'Include sub-companies') and even drops details present in the schema, such as the retrieveSize maximum of 200 and the startIndex minimum. It adds almost no meaning beyond structured fields.

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 pending consignments') plus the scoping condition ('created or updated within a UTC date range'), which is enough for an agent to distinguish it from ID/reference-based siblings like get_pending_consignments_by_ids. However, unlike the strongest definitions, it never names the sibling to prefer when a date range is not the right selector, so differentiation is implicit rather than explicit.

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 phrase 'Useful for sync workflows' implies the intended context and hints at a polling pattern, but there is no explicit when-to-use versus when-not-to-use guidance and no named alternative among the many pending-consignment and consignment list tools. The agent must infer the selection criteria from the tool name and the date-range requirement.

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