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
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:
- Sandbox (for testing): Sign up for sandbox
- Production (for live data): Sign up at production
- 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):Configure Your AI Assistant
Claude Desktop
Claude Desktop
- Open Claude Desktop’s configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
- Add the ShipBob MCP server configuration:
- Replace
YOUR_API_TOKENwith your actual ShipBob API token - Restart Claude Desktop
- Verify the connection by asking Claude: “What ShipBob tools are available?”
VS Code
VS Code
mcp.json file:Prerequisites:
- Install the latest version of Visual Studio Code
- Have access to GitHub Copilot
- Create Configuration File:
- Workspace: Create
.vscode/mcp.jsonin your workspace folder - User Profile: Use the command
MCP: Open User Configurationfrom the Command Palette (Ctrl+Shift+P)
- Workspace: Create
- Add ShipBob MCP Server Configuration:
- When you start using the MCP server, VS Code will prompt you for your API token (if using
${input:}), or ensure theSHIPBOB_API_TOKENenvironment variable is set (if using${env:}) - Trust the Server: When VS Code prompts you to trust the MCP server configuration, review the details and confirm
- Start the Server: Run
MCP: List Serversfrom the Command Palette and start the ShipBob Developer API server - Verify the connection by opening Copilot Chat and asking: “What ShipBob tools are available?”
Other MCP-Compatible Clients
Other MCP-Compatible Clients
-
Use the appropriate ShipBob MCP endpoint:
- Sandbox:
https://sandbox-api.shipbob.com/developer-api/mcp - Production:
https://api.shipbob.com/developer-api/mcp
- Sandbox:
-
Configure authentication using your ShipBob API token in the
Authorizationheader: - Follow your client’s specific MCP configuration instructions
- 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:Orders (11 tools)
Orders (11 tools)
- 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
Products (7 tools)
Products (7 tools)
- List all products
- Get product details by product ID
- Get product variants
- Browse product taxonomy
- Get taxonomy hierarchy
- View packaging requirements
Inventory (8 tools)
Inventory (8 tools)
- Get inventory list
- Get inventory levels by inventory ID
- View inventory across locations
- Get lot information
- Track inventory by fulfillment center
Channels (1 tool)
Channels (1 tool)
- 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:Example 2: Checking Inventory
You ask:Discovering Available Tools
To see all available ShipBob tools with detailed descriptions, ask your AI assistant:Security & Best Practices
When using the ShipBob MCP Server, follow these best practices to ensure security:- Protect Your API Token: Never share your API token or commit it to version control
- Use Environment-Specific Tokens: Use sandbox tokens for testing, production tokens for live operations
- Rotate Credentials Regularly: Regenerate API tokens periodically
- Use HTTPS: All connections to the MCP server use secure HTTPS
- 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
Connection Issues
Connection Issues
- 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
- Sandbox:
- Check your internet connection
- Ensure your AI assistant supports MCP protocol
- Verify your configuration file syntax is correct
Authentication Errors
Authentication Errors
- Verify your ShipBob API token is valid
- Check token hasn’t expired (regenerate if needed)
- Ensure the
Authorizationheader is properly formatted:Bearer YOUR_TOKEN - Confirm you’re using the right token for the environment (sandbox vs production)
No Tools Available
No Tools Available
- Verify the MCP server configuration in your AI assistant
- Restart your AI assistant after configuration changes
- Check that your API token has the necessary permissions
- Try asking: “What ShipBob tools are available?”
Tool Execution Failures
Tool Execution Failures
- Check that required parameters are provided
- Verify parameter formats match API requirements (e.g., dates, IDs)
- Review error message for specific guidance
- Consult ShipBob API documentation for parameter details
- Ensure you have permissions for the operation
Rate Limiting
Rate Limiting
- Check ShipBob API rate limits
- Reduce the frequency of requests
- Use batch operations when available
Data Accuracy Issues
Data Accuracy Issues
- Verify you’re using the correct environment (sandbox vs production)
- Check that data exists in your ShipBob account
- Ensure you have the right permissions to view the data
- Try the same query directly in the ShipBob dashboard
Frequently Asked Questions
What AI assistants are compatible?
What AI assistants are compatible?
Is there a cost to use the MCP Server?
Is there a cost to use the MCP Server?
Can I use this in production?
Can I use this in production?
https://api.shipbob.com/developer-api/mcp) with your production API credentials.How do I switch between sandbox and production?
How do I switch between sandbox and production?
- Sandbox:
https://sandbox-api.shipbob.com/developer-api/mcp+ sandbox token - Production:
https://api.shipbob.com/developer-api/mcp+ production token
Is my data secure?
Is my data secure?
What if I don't have API access yet?
What if I don't have API access yet?
Can I limit which tools my AI assistant can access?
Can I limit which tools my AI assistant can access?
Support & Resources
Getting Help
If you need assistance with the ShipBob MCP Server:- Email: [email protected]
- Documentation: https://developer.shipbob.com
- API Reference: ShipBob API Docs
When Contacting Support
Please include:- Environment: Development/Sandbox or Production
- AI Assistant: Which client you’re using (Claude Desktop, VS Code, etc.)
- Error Messages: Full error text if available
- Steps to Reproduce: What you asked your AI assistant to do
- Expected Behavior: What you expected to happen
- Actual Behavior: What actually happened
