Skip to main content
Glama

Shopmonkey MCP by usefulapi

Update an order

shopmonkey_update_order
Destructive

Update a work order — move it to another workflow status, change its status (Estimate, RepairOrder, Invoice), edit complaint/recommendation, due date, service writer, or archive it. Only the fields you pass are sent. Shopmonkey: PUT /v3/order/:id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoOrder name / title.
statusNoEstimate, RepairOrder or Invoice.
dueDateNoWhen the vehicle is promised, ISO 8601 date-time.
orderIdYesThe order id.
archivedNoArchive (true) or unarchive (false) the order.
complaintNoThe customer's complaint (reason for visit).
vehicleIdNoThe vehicle being worked on.
customerIdNoThe customer the order is for.
recommendationNoThe shop's recommendation.
serviceWriterIdNoUser id of the service writer.
workflowStatusIdNoWorkflow status (board column) id — see shopmonkey_list_workflow_statuses.
purchaseOrderNumberNoCustomer PO number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations only carry destructiveHint=true; the description supplements this with partial-update semantics ('only the fields you pass are sent'), the archive/unarchive behavior, and the underlying PUT /v3/order/:id contract. It stops short of disclosing permission requirements, reversibility of archive, or side effects on related entities.

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 compact sentences, front-loaded with the action and the mutable surface, closing with the API mapping. No filler, though the enumerated field list is somewhat redundant with the schema.

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 12-parameter mutation tool with no output schema, the description covers the mutation surface and the partial-payload rule, which is the main thing an agent must know. Gaps remain around failure modes, permissions, and whether archived state blocks further edits.

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 every parameter is already documented, including the status enum and the cross-reference to list_workflow_statuses. The description's field list largely restates the schema rather than adding format, default, or interaction semantics, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Update a work order') and enumerates exactly which facets can be changed (workflow status, status enum, complaint/recommendation, due date, service writer, archive), which cleanly separates it from create_order, get_order, and list_orders.

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 line 'Only the fields you pass are sent' is a useful patch-semantics cue, and the workflowStatusId field points at shopmonkey_list_workflow_statuses as a lookup. However there is no explicit when-to-use versus when-not-to-use guidance, no prerequisites (e.g. permissions, whether archived orders are editable), and no routing to a sibling for related operations.

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.