Skip to main content
Glama

Post Dispatch Updateshipmentdetails

hgr_post_dispatch_updateshipmentdetails
Destructive

Dedicated HGRApi tool for POST api/Dispatch/UpdateShipmentDetails. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST update shipment details operation in shipping and dispatch operations. Use when: Use it when a client needs to run the update shipment details operation for shipping and dispatch operations. Input: [FromBody] request: VelociPackerShipmentUpdateRequest. Main fields: TrackingCode: string, OrderReference: string, DeliveredOn: DateTime. Output: Returns the result or applies the effect of the update shipment details operation. Search terms: dispatch updateshipmentdetails. Send the exact request payload in body. Requires confirmed=true before execution.

Input Schema

NameRequiredDescriptionDefault
bodyYesHGRApi POST /api/Dispatch/UpdateShipmentDetails request body.
confirmedYesMust be true after the user explicitly requested or confirmed the exact action.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, openWorldHint=true, idempotentHint=false, and readOnlyHint=false. The description adds useful behavioral context: the endpoint is fixed, the exact payload must be sent in the body, and confirmed=true is required before execution. It does not explain what shipment details are overwritten or any side effects, so it adds some but not rich behavioral detail beyond annotations.

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 key information is front-loaded, but the description contains redundancy and filler: it repeats 'shipping and dispatch operations,' includes a 'Search terms' line, and has tautological 'Use when' phrasing. It is not excessively long, but several sentences do not earn their place.

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 destructive mutation, the description supplies the fixed endpoint, main body fields, exact-payload expectation, and the confirmed=true requirement. An output schema exists, so return-value details are not required, and annotations carry the safety profile. It is reasonably complete, though it could better explain what shipment details are changed and whether the update is partial or full replacement.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description goes beyond the schema's sparse body description by naming the request type and main body fields: TrackingCode, OrderReference, and DeliveredOn with types. It does not deeply document validation rules or partial-update semantics, but it meaningfully enriches parameter understanding.

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: POST api/Dispatch/UpdateShipmentDetails for updating shipment details. It also clarifies that this is a fixed-endpoint tool, not a generic caller. It does not explicitly distinguish itself from the sibling hgr_post_dispatch_getshipmentdetails, which prevents a 5.

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

Usage Guidelines2/5

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

The 'Use when' sentence essentially restates the purpose: 'Use it when a client needs to run the update shipment details operation.' It gives no meaningful when-to-use versus alternatives, no when-not-to-use, and no comparison with the sibling get-shipment-details tool. The confirmed=true prerequisite is useful but is a schema/execution requirement rather than selection guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources