SM

shipstation/mcp-shipstation-api

部署与 DevOps

本页由 AI 翻译,技术细节请以原文为准。 查看原文

12 stars 5 forks 质量 72 趋势 22

ShipStation API 的 MCP 服务器

概览

一个用于与ShipStation API v2互动的MCP(模式上下文协议)服务器. 该服务器为AI助手提供了与ShipStation功能互动的工具,包括货运,标签,费率,载体,库存,仓库,分批,以及货单等. - 创建、列出、获取、取消货运和检索费率 - 创建、列出、获取、取消标签和跟踪包 - 计算和估计货运费率 - 列表载体、服务和包类型 - :获取库存水平并更新库存 - 列表并获取仓库信息 - :创建和管理批次,用于批量标签处理 - :创建和管理日终处理清单 要使用此服务器, 并配备一个 MCP 相容的 AI 助手( 如 Claude Desktop), 请添加以下配置之一 : SHIPSTATION API URL环境变量是可选的. 如果不提供,则默认为标准的ShipStation API URL. 1. 2. 将您的 API 密钥放入.env 文件或通过 --env 旗 3.

概述(AI 翻译)

一个用于与ShipStation API v2互动的MCP(模式上下文协议)服务器. 该服务器为AI助手提供了与ShipStation功能互动的工具,包括货运,标签,费率,载体,库存,仓库,分批,以及货单等.

□ 特性

  • ** 货运**:建立、列出、获得、取消货运和回收费率
  • 标签: 创建、列表、获取、空白标签和音轨软件包
  • ** 运费**:计算和估计运费率
  • ** 承运人**:列出载体、服务和包型
  • ** 库存**:获得库存水平并更新库存
  • ** 仓库**:列出并获取仓库信息
  • Batches:为批量标签处理创建和管理批次
  • ** 管理**:建立和管理日终处理清单

□ 快开始

  1. ** 建立附属关系**:

  2. ** 设置环境变量**:

  3. 启动MCP服务器:

□ MCP 整合

要使用此服务器, 并配备一个 MCP 相容的 AI 助手( 如 Claude Desktop), 请添加以下配置之一 :

直接节点执行

** 注:** [T0] 环境变量是可选的。 如果不提供,则默认为标准的ShipStation API URL.

本页由 AI 翻译,技术细节请以原文为准。

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

  1. Install dependencies:

    npm install
    
  2. 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
    
  3. 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:

  1. Build the image first:
    cd /path/to/shipstation-api-mcp
    docker build -t shipstation-api-mcp .
    
  2. Set your API key in .env file or pass via --env flag
  3. 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 to https://api.shipstation.com)
在 GitHub 查看完整 README

安装

docker run --rm -i --env SHIPSTATION_API_KEY=your_api_key_here --env SHIPSTATION_API_URL=https://custom-api.example.com shipstation-api-mcp
新手?先看 mcpskill.org 教程 →

配置

{ "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" } } } }