使用说明

项目简介

OpenMCP Apideck Ecommerce Server 是 OpenMCP 项目中的一个模块，它基于 Model Context Protocol (MCP) 实现了对 Apideck Unified API 的集成。该服务器作为一个桥梁，使得大型语言模型 (LLM) 能够通过标准化的 MCP 协议，调用 Apideck Ecommerce API 提供的各种电商相关功能，例如检索商品信息、订单详情、客户列表等。

主要功能点

提供电商数据访问工具: 通过预定义的工具，LLM 可以查询 Apideck Unified API 提供的电商数据，包括产品、订单、客户和店铺信息。
支持多种查询参数: 工具支持丰富的查询参数，允许 LLM 精细化地控制数据检索，例如通过ID查询特定资源，或使用过滤器获取特定条件的数据列表。
安全认证: 支持 Apideck API 的密钥认证机制，保障数据访问安全。
标准化 MCP 协议: 完全遵循 MCP 协议标准，易于集成到任何兼容 MCP 协议的 LLM 客户端。
基于 Stdio 传输: 使用 Stdio 作为默认传输协议，方便部署和运行。

安装步骤

安装 npm 包: 确保你的环境中已安装 Node.js 和 npm。你可以通过 npm 安装 '@open-mcp/apideck_com_ecommerce' 包。
```
npm install @open-mcp/apideck_com_ecommerce
```
添加到 MCP 客户端配置: 使用 OpenMCP 提供的命令行工具 'add-to-client' 可以将服务器信息自动添加到你的 MCP 客户端配置文件中。请将 '/path/to/client/config.json' 替换为你的 MCP 客户端配置文件的实际路径。
```
npx @open-mcp/apideck_com_ecommerce add-to-client /path/to/client/config.json
```
或者，你也可以手动将以下服务器配置信息添加到你的 MCP 客户端配置文件 'config.json' 的 'mcpServers' 字段中。

服务器配置

以下是 'config.json' 中 'mcpServers' 字段的服务器配置示例，你需要根据实际情况进行修改：

{
  "mcpServers": {
    "apideck_com_ecommerce": {
      "env": {
        "AUTHORIZATION": "YOUR_APIDECK_API_KEY"
      },
      "command": "npx",
      "args": ["@open-mcp/apideck_com_ecommerce"]
    }
  }
}

配置参数说明:

'apideck_com_ecommerce': 服务器名称，用于在 MCP 客户端中唯一标识该服务器。
'env': 环境变量配置。
- 'AUTHORIZATION': 必填。你的 Apideck API 密钥。请替换为你在 Apideck 平台申请的 API 密钥。
'command': 启动服务器的命令，这里使用 'npx' 来运行 npm 包。
'args': 命令参数，指定要运行的 npm 包名称 '@open-mcp/apideck_com_ecommerce'。

注意: 你需要将 'YOUR_APIDECK_API_KEY' 替换为你自己的 Apideck API 密钥。你可以在 Apideck 开发者平台获取 API 密钥。

基本使用方法

启动 MCP 服务器: 当 MCP 客户端启动时，它会自动根据配置文件中的 'command' 和 'args' 启动 'apideck_com_ecommerce' 服务器。由于配置中使用 'stdio' 传输，服务器将通过标准输入输出与客户端通信。
在 LLM 中调用工具: 在你的 LLM 应用中，你可以指示 LLM 调用 'apideck_com_ecommerce' 服务器提供的工具来访问电商数据。例如，你可以使用 'productsone' 工具来获取特定产品的信息。工具的具体名称和参数可以在 'servers/apideck_com_ecommerce/build/operations/' 目录下的文件中找到，例如 'productsone.js' 文件定义了 'productsone' 工具。
查看响应: 服务器会将 API 响应封装成 MCP 格式返回给客户端，LLM 可以解析响应内容并从中提取所需的信息。

示例工具:

'customersall': 列出所有客户。
'customersone': 获取指定客户的信息。
'ordersall': 列出所有订单。
'ordersone': 获取指定订单的信息。
'productsall': 列出所有产品。
'productsone': 获取指定产品的信息。
'storesone': 获取店铺信息。

请参考每个工具的 'toolDescription' 来了解其具体功能和使用方法。

关键词