关键词

库存管理销售分析账户追踪零售业务AI助手集成

项目简介

'mcp-consigncloud' 是一个基于 Model Context Protocol (MCP) 实现的服务器，旨在将 ConsignCloud 的库存、销售、账户管理等核心业务功能暴露给大型语言模型（LLM）驱动的AI助手。通过这个服务器，AI助手能够以标准化的方式直接查询业务数据、执行管理操作，从而帮助用户更高效、智能地管理零售和寄售业务。

主要功能点

  • 库存管理: AI助手可以查询、创建、修改、删除库存商品。支持按价格、商品类别、关联账户、商品状态、存放地点等多种条件进行筛选。此外，还能获取库存统计数据，进行批量编辑，并更新商品状态。
  • 销售管理: 助手能够列出和查看详细的销售记录，执行作废或退款操作。支持按日期、客户、销售地点、交易状态进行筛选，并获取销售趋势和分析报告。
  • 账户管理: 便于管理供应商（寄售人）账户，查看账户余额和相关统计。助手可以追踪每个账户的采购记录和关联商品，帮助维护良好的合作关系。
  • 业务计算与分析: 提供强大的聚合计算能力，能够自动计算库存总价值、销售总额、以及特定账户的综合指标（如可用库存价值、已售商品数量、应付佣金等），支持多种过滤和分组维度，为决策提供数据支持。
  • 基础数据管理: 助手还可以管理商品类别和商店位置信息，以及创建和管理商品批次。
  • 跨实体搜索与建议: 提供模糊搜索能力，可以在库存商品和账户之间进行快速搜索，并针对特定字段提供自动完成建议。

安装步骤

在您的本地机器上安装 ConsignCloud MCP 服务器非常简单：

  1. 克隆仓库: 打开您的终端或命令行工具，运行以下命令下载项目代码：

    git clone https://github.com/modellers/mcp-consigncloud
cd mcp-consigncloud

  2. 安装依赖: 进入项目目录后，安装所有必需的软件依赖：

    npm install

  3. 配置API密钥:

    • 首先，复制 '.env.example' 文件来创建 '.env' 文件： 
      cp .env.example .env
    • 然后，打开新创建的 '.env' 文件进行编辑。您需要将 'CONSIGNCLOUD_API_KEY=your_api_key_here' 中的 'your_api_key_here' 替换为您真实的 ConsignCloud API 密钥。
    • 获取API密钥指南:
      1. 登录您的 ConsignCloud 账户。
      2. 导航到 Settings → Apps 页面。
      3. 找到并启用 API & Webhooks 应用。
      4. 点击 Add API Key 生成一个新的API密钥。
      5. 将生成的API密钥复制粘贴到您的 '.env' 文件中。
    • '.env' 文件内容示例： 
      CONSIGNCLOUD_API_KEY=sk_your_actual_api_key_here
CONSIGNCLOUD_API_BASE_URL=https://api.consigncloud.com/api/v1

服务器配置

该MCP服务器支持两种运行模式：Stdio模式（推荐用于与LLM客户端如Claude Desktop集成）和HTTP/SSE模式（推荐用于测试和HTTP/SSE兼容客户端）。

1. 配置给MCP客户端（例如 Claude Desktop）

要将此MCP服务器集成到您的LLM客户端中（例如 Claude Desktop），您需要配置服务器的启动命令及其参数。通常，您会在客户端的配置文件中添加一个JSON对象。

示例配置信息 (JSON格式，可根据您的客户端和路径调整):

{
  "mcpServers": {
    "consigncloud": {
      "command": "node",
      "args": ["/Users/administrators/Documents/Workspace/github/mcp-consigncloud/dist/index.js"],
      "env": {
        "CONSIGNCLOUD_API_KEY": "sk_your_api_key_here"
      },
      "description": "连接到ConsignCloud API，提供库存、销售和账户管理工具。"
    }
  }
}
  • 'command': 指定启动服务器的执行程序，这里是 'node'。
  • 'args': 一个数组，包含传递给 'command' 的参数。第一个参数通常是服务器的入口文件路径。请务必将 '/Users/administrators/Documents/Workspace/github/mcp-consigncloud/dist/index.js' 替换为您的项目中 'dist/index.js' 文件的绝对路径。
  • 'env' (可选): 一个对象，用于设置服务器运行时的环境变量。如果您不想将API密钥直接写在 '.env' 文件中，可以在这里以 '"CONSIGNCLOUD_API_KEY": "您的ConsignCloud API密钥"' 的形式提供。如果密钥已在 '.env' 文件中配置，此字段可以省略。
  • 'description' (可选): 对该服务器的简要描述。

2. 在HTTP/SSE模式下启动服务器（用于测试或HTTP/SSE兼容客户端）

如果您想以HTTP/SSE模式运行服务器（例如使用MCP Inspector进行测试），您可以这样做：

  • 启动服务器: 在项目目录下运行以下命令来启动HTTP/SSE服务器：

    npm run start:http

    服务器默认将监听 'http://localhost:3000'。您可以通过修改 '.env' 文件或使用命令行参数 '--port' 和 '--host' 来自定义端口和主机名。

  • 客户端连接信息: 一旦服务器启动，您的MCP客户端应配置连接到 'http://localhost:3000/sse'。 例如，使用MCP Inspector进行测试：

    npx @modelcontextprotocol/inspector http://localhost:3000/sse

基本使用方法

一旦 ConsignCloud MCP 服务器成功配置并与您的AI助手建立连接，您的AI助手就可以理解 ConsignCloud 提供的各种功能，并根据您的指令执行操作。以下是一些您可以向AI助手提出的示例请求：

  • "列出所有价格低于 50 美元（即 5000 美分）的库存商品。"
  • "显示上周的所有销售记录。"
  • "为名为 'John Doe' 的新供应商创建一个账户。"
  • "计算所有状态为 'available' 的库存商品的总价值，并按商品类别进行分组。"
  • "统计过去一个月的销售总额和平均销售额，并按日期进行分组。"
  • "给我 ID 为 'ABC123' 的账户的详细指标，包括他们的当前余额、可用库存价值和应付佣金。"
  • "查询所有状态为 'completed' 且客户名为 'Alice Smith' 的销售记录。"
  • "创建一个新的商品类别，命名为 'Vintage Electronics'。"
  • "使用关键词 'summer dress' 搜索所有相关的库存商品和账户信息。"

信息

分类

商业系统

访问项目