
shipstation/mcp-shipstation-api
Deployment & DevOpsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
MCP server for ShipStation APIs
Обзор
An MCP (Model Context Protocol) server for interacting with the ShipStation API v2. This server provides tools for AI assistants to interact with ShipStation functionality including shipments, labels, rates, carriers, inventory, warehouses, batches, and manifests. - : Create, list, get, cancel shipments and retrieve rates - : Create, list, get, void labels and track packages - : Calculate and estimate shipping rates - : List carriers, services, and package types - : Get inventory levels and update stock - : List and get warehouse information - : Create and manage batches for bulk label processing - : Create and manage manifests for end-of-day processing To use this server with an MCP-compatible AI assistant (like Claude Desktop), add one of the following configurations: The SHIPSTATION_API_URL environment variable is optional. If not provided, it defaults to the standard ShipStation API URL. 1. 2. Set your API key in .env file or pass via --env flag 3.
README
Показан фрагмент оригинального README. Открыть оригинал.
ShipStation API MCP Server
An MCP (Model Context Protocol) server for interacting with the ShipStation API v2. This server provides tools for AI assistants to interact with ShipStation functionality including shipments, labels, rates, carriers, inventory, warehouses, batches, and manifests.
Features
- Shipments: Create, list, get, cancel shipments and retrieve rates
- Labels: Create, list, get, void labels and track packages
- Rates: Calculate and estimate shipping rates
- Carriers: List carriers, services, and package types
- Inventory: Get inventory levels and update stock
- Warehouses: List and get warehouse information
- Batches: Create and manage batches for bulk label processing
- Manifests: Create and manage manifests for end-of-day processing
Quick Start
-
Install dependencies:
npm install -
Set up environment variables:
cp .env.example .env # Edit .env and add your ShipStation API key # NEVER commit .env to git - it contains sensitive API keys -
Start the MCP server:
npm start # or for development with auto-reload: npm run dev
MCP Integration
To use this server with an MCP-compatible AI assistant (like Claude Desktop), add one of the following configurations:
Direct Node.js Execution
{
"mcpServers": {
"shipstation": {
"command": "node",
"args": ["/path/to/shipstation-api-mcp/src/mcp-server.js"],
"env": {
"SHIPSTATION_API_KEY": "your_api_key_here",
"SHIPSTATION_API_URL": "https://custom-api.example.com"
}
}
}
}
Note: The SHIPSTATION_API_URL environment variable is optional. If not provided, it defaults to the standard ShipStation API URL.
Docker Container
{
"mcpServers": {
"shipstation": {
"command": "docker",
"args": [
"run",
"--rm",
"-i",
"--env",
"SHIPSTATION_API_KEY=your_api_key_here",
"--env",
"SHIPSTATION_API_URL=https://custom-api.example.com",
"shipstation-api-mcp"
]
}
}
}
Docker Compose
{
"mcpServers": {
"shipstation": {
"command": "docker-compose",
"args": [
"run",
"--rm",
"shipstation-mcp"
],
"cwd": "/path/to/shipstation-api-mcp"
}
}
}
Docker Setup:
- Build the image first:
cd /path/to/shipstation-api-mcp docker build -t shipstation-api-mcp . - Set your API key in
.envfile or pass via--envflag - For Docker Compose:
docker-compose up shipstation-mcp
Note: The Docker image must be built with the tag shipstation-api-mcp to match the MCP configuration above.
Environment Variables
SHIPSTATION_API_KEY- Your ShipStation API key (required)SHIPSTATION_API_URL- Custom ShipStation API base URL (optional, defaults tohttps://api.shipstation.com)
Установка
docker run --rm -i --env SHIPSTATION_API_KEY=your_api_key_here --env SHIPSTATION_API_URL=https://custom-api.example.com shipstation-api-mcpКонфигурация
{
"mcpServers": {
"shipstation": {
"command": "node",
"args": ["/path/to/shipstation-api-mcp/src/mcp-server.js"],
"env": {
"SHIPSTATION_API_KEY": "your_api_key_here",
"SHIPSTATION_API_URL": "https://custom-api.example.com"
}
}
}
}