Setup
The ShipBob MCP Server is hosted by ShipBob. Setup is the same across every AI app that supports it:
- Open your app’s MCP or connector settings
- Add a new server with the ShipBob URL
- Your app opens a browser window where you sign in to ShipBob
- Grant access on the consent screen
- Start asking the assistant about your data
Server URLs
Use the URL that matches the environment you want to talk to.
What the Consent Screen Asks For
On first connection, ShipBob asks you to create a channel for the AI client and shows the permissions the MCP tools need to function. A channel is how ShipBob tracks which app created which records — it is an installation of an application on top of the ShipBob API.
- Reads cross channels: The AI client can read data from every channel on your merchant account (orders from Shopify, Amazon, other apps, PAT-issued channels, etc.).
- Permissions follow your account role: The tools available to you depend on your ShipBob account’s permission level. If a tool returns a 403 error, your account role may not have access to that operation — contact your ShipBob account admin to confirm.
For background on channels, see Concepts > Channel.
Configure Your AI Assistant
claude.ai
- Open claude.ai in your browser
- Open the sidebar and go to Customize → Connectors → Click on + icon → Add custom connector (or use the direct link below)
- Enter the name
ShipBoband paste the server URL for your environment - Click Add. Claude opens a browser tab for sign-in.
- Sign in with your ShipBob account and grant access on the consent screen
- The connector shows as Connected in your claude.ai customization settings
Direct deep-link to add the connector:
Claude Desktop
- Open Claude Desktop
- Open the sidebar and go to Customize → Connectors → Click on + icon → Add custom connector
- Enter the name
ShipBoband paste the server URL for your environment - Click Add. Claude opens a browser window for sign-in.
- Sign in with your ShipBob account and grant access on the consent screen
- Back in Claude Desktop, the connector shows as Connected
If you don’t see the option to add a custom connector
Register the ShipBob MCP Server by editing Claude Desktop’s config file directly. This uses the mcp-remote helper to bridge Claude Desktop to the hosted server while still keeping the browser-based OAuth sign-in.
Prerequisite — Node.js
The mcp-remote helper runs on Node.js. If you don’t already have it, download and install Node.js (LTS). After installing, open a terminal and run node --version to confirm — you should see a version like v24.15.0.
Steps
-
Open the config file:
- Windows: File → Settings → Developer → Edit Config
- Mac: Claude (menu bar) → Settings → Developer → Edit Config
A file called
claude_desktop_config.jsonopens in your text editor (Notepad on Windows, the default editor on Mac). -
Add the ShipBob server:
Empty config file
File already has other servers
If the file is empty or contains only
{}, replace its contents with:For sandbox, swap the URL for
https://sandbox-api.shipbob.com/developer-api/mcp. -
Save the file and fully quit Claude Desktop (don’t just close the window). Reopen it.
-
On first use of a ShipBob tool, Claude Desktop opens a browser for the ShipBob sign-in / consent screen — same flow as the GUI path.
Claude Code CLI
Claude Code registers MCP servers from the terminal — no config-file editing needed.
Add the ShipBob server (production):
Add the sandbox server:
--transport httpmatches the Streamable HTTP transport the ShipBob server uses.--scope userregisters the server for your user across every Claude Code project. Use--scope project(or omit the flag) if you only want it inside the current project.
The first tool call against the server opens a browser for ShipBob sign-in and the consent screen — the same OAuth flow every other client uses.
Remove the server:
Run claude mcp list at any time to see which servers are registered.
VS Code with GitHub Copilot
Prerequisites
- Latest Visual Studio Code
- Access to GitHub Copilot
One-click install:
Click the link below to add the ShipBob MCP server to VS Code automatically:
- Production: Install ShipBob MCP Server in VS Code
- Sandbox: Install ShipBob Sandbox MCP Server in VS Code
VS Code opens a prompt to confirm the server installation. After confirming, it opens a browser for sign-in.
Manual setup:
-
Choose where the MCP config lives:
- Workspace (
.vscode/mcp.json): use this for project-specific access. Teammates who check out the repo also get the server. - User profile (run
MCP: Open User Configurationfrom the Command Palette withCtrl+Shift+P/Cmd+Shift+P): use this to make the server available across all your projects.
- Workspace (
-
Add the ShipBob server:
Swap the URL for
https://sandbox-api.shipbob.com/developer-api/mcpto point at sandbox. -
Run
MCP: List Serversand startshipbob. VS Code opens a browser for sign-in. -
Sign in with your ShipBob account and grant access.
mcp.json.Other AI Apps
Any app that supports remote MCP servers works the same way:
- Add a new remote / custom MCP server in the app
- Paste the ShipBob URL for your environment
- Sign in to ShipBob in the browser window your app opens
No API tokens, headers, or extra tools are needed.
Verify the Connection
Once the server is added, ask the assistant:
You should see a list of all available ShipBob tools. If nothing appears, see Troubleshooting.
Tool Approval Behavior
The ShipBob MCP Server exposes read-only tools. Your AI client controls whether tool calls require approval. claude.ai, Claude Desktop, and VS Code with GitHub Copilot typically run read-only tools without a confirmation prompt, so responses are fast and conversational.
Next Steps
- Tools & Examples - See what you can ask
- Troubleshooting & FAQ - Fix common issues
- Setup with API Token - Alternative setup using an API token you generate from your ShipBob dashboard, for apps or workflows that don’t support sign-in through the browser

