Skip to main content
Glama
mattcoatsworth

ShipStation API MCP Server

restore_order_from_hold

Releases a held order in ShipStation to resume normal processing. Specify the order ID to reactivate fulfillment workflows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orderIdYesOrder ID to restore

Implementation Reference

  • Registration of the 'restore_order_from_hold' tool in the orderTools array, including name, description, input schema, and handler function.
    {
      name: "restore_order_from_hold",
      description: "Restore an order from on-hold status",
      schema: {
        orderId: z.number().describe("Order ID to restore")
      },
      handler: async ({ orderId }) => {
        try {
          const result = await shipStationClient.restoreOrderFromHold({ orderId });
          return {
            content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
          };
        } catch (error) {
          return {
            content: [{ type: "text", text: error.message }],
            isError: true
          };
        }
      }
    },
  • Zod schema for the tool input: requires orderId as number.
    schema: {
      orderId: z.number().describe("Order ID to restore")
    },
  • The main tool handler that calls the ShipStation API via shipStationClient and returns formatted response or error.
    handler: async ({ orderId }) => {
      try {
        const result = await shipStationClient.restoreOrderFromHold({ orderId });
        return {
          content: [{ type: "text", text: JSON.stringify(result, null, 2) }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: error.message }],
          isError: true
        };
      }
    }
  • ShipStationClient method that makes the POST request to /orders/restorefromhold endpoint to restore the order.
    async restoreOrderFromHold(data) {
      return this.request('POST', '/orders/restorefromhold', data);
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mattcoatsworth/shipstation-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server