AI
Build with AI
ShipThis is built to be used by AI agents as well as people. Connect your agent to the ShipThis MCP serverto call the platform’s tools and APIs, and point tools at our llms.txt for AI-friendly docs discovery.
Model Context Protocol (MCP) server
The ShipThis MCP server exposes platform tools (reporting, navigation, and operations — e.g. get_report_info, generate_report_url, get_layout) to MCP-compatible clients such as Claude, Cursor, and Windsurf.
Every tool runs as the user that owns the API key, so the data and actions available follow that user’s roles and permissions.
- Endpoint
- https://mcp.shipthis.ai/mcp
- Transport
- streamable-http
- Auth
- x-api-key + organisation
Connect a client
First, generate an API key from your ShipThis account. Every request needs two headers: x-api-key (your API key) and organisation(your organisation identifier, e.g. the slug in your manage URL). Without both you’ll get Access denied. Setup differs slightly per client.
Cursor
Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (per project):
{
"mcpServers": {
"shipthis": {
"url": "https://mcp.shipthis.ai/mcp",
"headers": {
"x-api-key": "YOUR_SHIPTHIS_API_KEY",
"organisation": "YOUR_ORG"
}
}
}
}Claude Code
Register the server from your terminal:
claude mcp add --transport http shipthis https://mcp.shipthis.ai/mcp \
--header "x-api-key: YOUR_SHIPTHIS_API_KEY" \
--header "organisation: YOUR_ORG"Claude Desktop
Claude Desktop’s connector UI only supports OAuth, so for header auth bridge the server with mcp-remote in claude_desktop_config.json:
{
"mcpServers": {
"shipthis": {
"command": "npx",
"args": [
"-y", "mcp-remote",
"https://mcp.shipthis.ai/mcp",
"--header", "x-api-key:${SHIPTHIS_API_KEY}",
"--header", "organisation:${SHIPTHIS_ORG}"
],
"env": {
"SHIPTHIS_API_KEY": "YOUR_SHIPTHIS_API_KEY",
"SHIPTHIS_ORG": "YOUR_ORG"
}
}
}
}Optional headers. region, usertype, and locationare sent by the ShipThis web app for UI context and aren’t required by the MCP server — auth and the data you can access are scoped by your API key and organisation. If your organisation spans multiple regions, you can pass region (e.g. usa) to target a specific one.
Other clients (Windsurf, VS Code, and similar) use the same url + x-api-key + organisationshape as Cursor — check your client’s docs for the exact config file. See the API reference for the full set of operations.
Available tools (31)
The tools your MCP client can call. The exact set depends on the API key’s roles and permissions.
Essential · 3
Navigation · 2
Reporting · 4
Read · 6
Configuration · 3
Workflow · 7
Write · 4
Audit · 2
Example prompts
Once connected, ask your agent in plain language — it picks the right tools on its own. A few things you can try:
- “What collections and views can I access?”get_collection_list, get_layout
- “How many shipments are in each workflow status?”count_documents_by_status
- “Build a report of overdue invoices this month and give me a shareable link.”create_ai_report, generate_report_url
- “Find the coordinates and country for the port of Rotterdam.”search_location
- “Show the recent edit history for this shipment.”get_document_history
Calling the server directly? Tools use the MCP tools/call method over the streamable-http transport (initialize → notifications/initialized → tools/call), with your x-api-key and organisation headers on every request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "search_location",
"arguments": { "query": "Rotterdam" }
}
}llms.txt
This portal publishes an /llms.txt index and a full /llms-full.txt document so AI tools can discover and read our docs, SDKs, and API reference. Point your agent or IDE at these URLs for ShipThis context.