Skip to main content

What is MCP?

The Model Context Protocol (MCP) is an open protocol that standardizes how AI assistants connect to external data sources and tools. The ShipBob MCP Server acts as a bridge between your AI assistant and the ShipBob API, enabling natural language interactions with your fulfillment operations.

Transport Protocol

The ShipBob MCP Server uses Streamable HTTP transport, which provides:
  • HTTP-based communication for easy integration
  • Server-Sent Events (SSE) support for real-time streaming responses
  • RESTful architecture compatible with standard HTTP clients
  • Stateful sessions for maintaining connection context
  • HTTP-Based: Uses standard Streamable HTTP transport for broad compatibility
This transport method is ideal for web-based AI assistants and provides reliable, secure communication over HTTPS.
The server exclusively uses Streamable HTTP transport as defined in the MCP specification. Other transport protocols (stdio, sse) are not supported.

Key Benefits

  • Natural Language Interface: Ask your AI assistant to check orders, view inventory, or browse products using plain English
  • AI-Powered Workflows: Let AI assistants help automate routine ShipBob tasks
  • Secure Access: All API calls use your existing ShipBob authentication credentials
  • Real-Time Data: Get live information about orders, inventory, and shipments
  • Developer Friendly: Works with popular AI development tools like Claude Desktop and VS Code

Prerequisites

Before you begin, you’ll need:
  • ShipBob Account:
  • ShipBob API Access: API credentials from your ShipBob account
  • AI Assistant: Claude Desktop, VS Code with MCP extension, or another MCP-compatible client
  • Basic Setup Knowledge: Familiarity with API concepts and JSON configuration

Quick Start

The ShipBob MCP Server is hosted and maintained by ShipBob. You don’t need to install or run any server software—simply configure your AI assistant to connect to it.

Getting Your ShipBob API Credentials

Before configuring the MCP Server, you’ll need to generate an API token from your ShipBob account. 📖 ShipBob Authentication Guide The authentication guide provides step-by-step instructions for generating your API credentials. Once you have your API token, you can configure your AI assistant to connect to the ShipBob MCP Server.

Connecting to the ShipBob MCP Server

Server Connection Details

Use these endpoints to connect your AI assistant to the ShipBob MCP Server: Sandbox (Development/Testing):
URL: https://sandbox-api.shipbob.com/developer-api/mcp
Environment: Development/Testing
Production:
URL: https://api.shipbob.com/developer-api/mcp
Environment: Live Orders and Data

Configure Your AI Assistant

To use the ShipBob MCP server with Claude Desktop:
  1. Open Claude Desktop’s configuration file:
    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. Add the ShipBob MCP server configuration:
Configuration:
{
  "mcpServers": {
    "shipbob-developer-api": {
      "url": "https://api.shipbob.com/developer-api/mcp",
      "transportType": "http",
      "headers": {
        "Authorization": "Bearer YOUR_API_TOKEN"
      }
    }
  }
}
  1. Replace YOUR_API_TOKEN with your actual ShipBob API token
  2. Restart Claude Desktop
  3. Verify the connection by asking Claude: “What ShipBob tools are available?”
To integrate with VS Code, you’ll need to configure an MCP server in your mcp.json file:
Prerequisites:
  1. Create Configuration File:
    • Workspace: Create .vscode/mcp.json in your workspace folder
    • User Profile: Use the command MCP: Open User Configuration from the Command Palette (Ctrl+Shift+P)
  2. Add ShipBob MCP Server Configuration:
Configuration:
{
  "servers": {
    "shipbob-developer-api": {
      "type": "http",
      "url": "https://api.shipbob.com/developer-api/mcp",
      "headers": {
        "Authorization": "Bearer ${input:shipbob-api-token}"
      }
    }
  },
  "inputs": [
    {
      "type": "promptString",
      "id": "shipbob-api-token",
      "description": "ShipBob API Token",
      "password": true
    }
  ]
}
Alternative: Using Environment Variables:
{
  "servers": {
    "shipbob-developer-api": {
      "type": "http",
      "url": "https://api.shipbob.com/developer-api/mcp",
      "headers": {
        "Authorization": "Bearer ${env:SHIPBOB_API_TOKEN}"
      }
    }
  }
}
  1. When you start using the MCP server, VS Code will prompt you for your API token (if using ${input:}), or ensure the SHIPBOB_API_TOKEN environment variable is set (if using ${env:})
  2. Trust the Server: When VS Code prompts you to trust the MCP server configuration, review the details and confirm
  3. Start the Server: Run MCP: List Servers from the Command Palette and start the ShipBob Developer API server
  4. Verify the connection by opening Copilot Chat and asking: “What ShipBob tools are available?”
For more details on VS Code MCP configuration, see the VS Code MCP Documentation.
For other MCP-compatible AI assistants:
  1. Use the appropriate ShipBob MCP endpoint:
    • Sandbox: https://sandbox-api.shipbob.com/developer-api/mcp
    • Production: https://api.shipbob.com/developer-api/mcp
  2. Configure authentication using your ShipBob API token in the Authorization header:
    Authorization: Bearer YOUR_API_TOKEN
    
  3. Follow your client’s specific MCP configuration instructions
  4. Verify the connection by listing available tools

Available Tools

The ShipBob MCP Server currently provides 27 tools to interact with your ShipBob data across the following categories:
Currently, all tools provide read-only access to view and query your data. Tools for creating or modifying data are not yet available.
  • Get orders list with filtering
  • Get order details by order ID
  • Get shipments by order ID
  • Get shipment details
  • Get shipment timeline and logs
  • Get shipping methods
  • View store order JSON
  • List all products
  • Get product details by product ID
  • Get product variants
  • Browse product taxonomy
  • Get taxonomy hierarchy
  • View packaging requirements
  • Get inventory list
  • Get inventory levels by inventory ID
  • View inventory across locations
  • Get lot information
  • Track inventory by fulfillment center
  • View channel

Using ShipBob with Your AI Assistant

Once configured, you can interact with ShipBob using natural language through your AI assistant.

Example 1: Viewing Recent Orders

You ask:
"Show me my last 10 orders from ShipBob"
AI Response: The assistant will call the ShipBob API and display your recent orders with details like order numbers, status, customer information, and tracking data.

Example 2: Checking Inventory

You ask:
"What's the current inventory level for SKU COFFEE-001?"
AI Response: The assistant will query inventory levels across all fulfillment centers and provide real-time stock information.

Discovering Available Tools

To see all available ShipBob tools with detailed descriptions, ask your AI assistant:
"What ShipBob tools are available?"

Security & Best Practices

When using the ShipBob MCP Server, follow these best practices to ensure security:
  1. Protect Your API Token: Never share your API token or commit it to version control
  2. Use Environment-Specific Tokens: Use sandbox tokens for testing, production tokens for live operations
  3. Rotate Credentials Regularly: Regenerate API tokens periodically
  4. Use HTTPS: All connections to the MCP server use secure HTTPS
  5. Understand Token Scopes: Ensure your API token has the required scopes for the operations you need. Insufficient permissions will result in 403 Forbidden errors

Troubleshooting

Problem: AI assistant cannot connect to ShipBob MCP ServerSolutions:
  1. Verify you’re using the correct endpoint URL:
    • Sandbox: https://sandbox-api.shipbob.com/developer-api/mcp
    • Production: https://api.shipbob.com/developer-api/mcp
  2. Check your internet connection
  3. Ensure your AI assistant supports MCP protocol
  4. Verify your configuration file syntax is correct
Problem: Requests fail with “401 Unauthorized” or “403 Forbidden”Solutions:
  1. Verify your ShipBob API token is valid
  2. Check token hasn’t expired (regenerate if needed)
  3. Ensure the Authorization header is properly formatted: Bearer YOUR_TOKEN
  4. Confirm you’re using the right token for the environment (sandbox vs production)
Problem: AI assistant reports no ShipBob tools are availableSolutions:
  1. Verify the MCP server configuration in your AI assistant
  2. Restart your AI assistant after configuration changes
  3. Check that your API token has the necessary permissions
  4. Try asking: “What ShipBob tools are available?”
Problem: Tools execute but return errorsSolutions:
  1. Check that required parameters are provided
  2. Verify parameter formats match API requirements (e.g., dates, IDs)
  3. Review error message for specific guidance
  4. Consult ShipBob API documentation for parameter details
  5. Ensure you have permissions for the operation
Problem: Requests are being throttledSolutions:
  1. Check ShipBob API rate limits
  2. Reduce the frequency of requests
  3. Use batch operations when available
Problem: Data returned doesn’t match expectationsSolutions:
  1. Verify you’re using the correct environment (sandbox vs production)
  2. Check that data exists in your ShipBob account
  3. Ensure you have the right permissions to view the data
  4. Try the same query directly in the ShipBob dashboard

Frequently Asked Questions

Any MCP-compatible AI assistant that supports Streamable HTTP transport.
The MCP Server is free to use for ShipBob customers.
Yes! Use the production endpoint (https://api.shipbob.com/developer-api/mcp) with your production API credentials.
Simply update your AI assistant’s configuration to use the appropriate endpoint URL and API token:
  • Sandbox: https://sandbox-api.shipbob.com/developer-api/mcp + sandbox token
  • Production: https://api.shipbob.com/developer-api/mcp + production token
Yes. All communication is encrypted via HTTPS, your API token is securely validated, and no data is stored or shared by the MCP server.
Follow the ShipBob Authentication Guide to set up API access for your ShipBob account. The guide covers both sandbox and production environment setup.
The AI assistant will only perform actions you explicitly request. Your ShipBob API token’s permissions also control what actions are possible.

Support & Resources

Getting Help

If you need assistance with the ShipBob MCP Server:

When Contacting Support

Please include:
  1. Environment: Development/Sandbox or Production
  2. AI Assistant: Which client you’re using (Claude Desktop, VS Code, etc.)
  3. Error Messages: Full error text if available
  4. Steps to Reproduce: What you asked your AI assistant to do
  5. Expected Behavior: What you expected to happen
  6. Actual Behavior: What actually happened