{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/mcp/quickstart/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Quickstart

\n

Connect an AI assistant to Shipwell in under 10 minutes.

\n

Prerequisites

\n\n
Read-only by default

The MCP server starts in read-only mode. Your AI assistant can query all data the token's user has access to, but cannot create or modify anything until write access is explicitly enabled on your account. See Safety & Write Access.

For production setups, use a dedicated integration user's token rather than a personal token — see Best Practices.

\n

Connection Modes

\n

HTTPS (Recommended)

\n

The hosted MCP server runs over HTTPS. Authentication is stateless — your Shipwell API token is passed in the Authorization header on each request and is never stored server-side. Use this for shared or remote deployments.

\n

Stdio (Local process)

\n

Run the MCP server as a local process with your token set as an environment variable. Best for individual developer setups or air-gapped environments.

\n

Setup — Claude Desktop

\n
    \n
  1. \nObtain your Shipwell API token from \nSettings → API Management\n
    2. \n
  2. \nOpen your Claude Desktop config file:\n\n
    3. \n
  3. \nAdd the following block inside \n\"mcpServers\"\n:\n
    4. \n
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"mcpServers\": {\n    \"shipwell\": {\n      \"command\": \"npx\",\n      \"args\": [\n        \"mcp-remote\",\n        \"https://mcp.shipwell.com/mcp\",\n        \"--header\",\n        \"Authorization: Bearer YOUR_SHIPWELL_API_TOKEN\"\n      ]\n    }\n  }\n}
\n
\n
    \n
  1. \nReplace \nYOUR_SHIPWELL_API_TOKEN\n with your token\n
    2. \n
  2. \nRestart Claude Desktop\n
    3. \n
\n

Setup — Cursor

\n
    \n
  1. \nOpen \nCursor Settings → MCP\n
    2. \n
  2. \nAdd a new MCP server with:\n\n
    3. \n
  3. \nSave and reload\n
    4. \n
\n

Setup — Claude Code (CLI)

\n
\n
\n
Copy
\n
Copied
\n
\n 
claude mcp add shipwell \\\n  --transport http \\\n  --url https://mcp.shipwell.com/mcp \\\n  --header \"Authorization: Bearer YOUR_SHIPWELL_API_TOKEN\"
\n
\n

Verifying the Connection

\n

Once connected, ask your AI assistant:

\n
\n

\"List my active shipments in Shipwell\"

\n
\n

The agent will auto-discover all 90+ tools via MCP tool discovery — no API docs required.

\n
Note

To use the sandbox environment, replace mcp.shipwell.com with sandbox-mcp.shipwell.com in any of the configs above.

\n

Next Steps

\n","headings":[{"value":"Quickstart","depth":1},{"value":"Prerequisites","depth":2},{"value":"Connection Modes","depth":2},{"value":"Setup — Claude Desktop","depth":2},{"value":"Setup — Cursor","depth":2},{"value":"Setup — Claude Code (CLI)","depth":2},{"value":"Verifying the Connection","depth":2},{"value":"Next Steps","depth":2}]},"contentItem":{"data":{"lastModified":"2026-05-14T19:02:55.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"103ddc0b-9a30-5173-ae9d-a5f88ee275b4__redocly content/docs/mcp/quickstart/","seo":{"title":"Quickstart","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/mcp/quickstart.md","pageBaseUrl":"/docs/mcp/quickstart","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Quickstart","id":"quickstart"},{"depth":2,"value":"Prerequisites","id":"prerequisites"},{"depth":2,"value":"Connection Modes","id":"connection-modes"},{"depth":2,"value":"Setup — Claude Desktop","id":"setup--claude-desktop"},{"depth":2,"value":"Setup — Cursor","id":"setup--cursor"},{"depth":2,"value":"Setup — Claude Code (CLI)","id":"setup--claude-code-cli"},{"depth":2,"value":"Verifying the Connection","id":"verifying-the-connection"},{"depth":2,"value":"Next Steps","id":"next-steps"}]},"data":{"title":""},"catalogInfo":null,"link":"/docs/mcp/quickstart/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}