使用说明
@virtocommerce/mcp-onx
用于商业运营基金会（COF）MCP服务器的VirtoCommerce适配器。通过模型上下文协议（MCP）将VirtoCommerce平台连接到AI助手，实现订单管理、客户查找、产品目录、库存、履行和退货操作。
支持的操作
| 类别 | 工具 |
|---|---|
| 订单 | create-sales-order, update-order, cancel-order, get-orders |
| 满足 | fulfill-order, get-fulfillments |
| 客户 | get-customers |
| 产品 | get-products, get-product-variants |
| 库存 | get-inventory |
| 退货 | create-return, get-returns |
快速开始
选项A：通过npx（不需要本地克隆）
添加到您的Claude桌面配置(claude_desktop_config.json):
{
"mcpServers": {
"cof-mcp": {
"command": "npx",
"args": [
"--package=@virtocommerce/cof-mcp",
"--package=@virtocommerce/mcp-onx",
"--yes",
"cof-mcp"
],
"env": {
"ADAPTER_TYPE": "npm",
"ADAPTER_PACKAGE": "@virtocommerce/mcp-onx",
"ADAPTER_CONFIG": "{\"apiUrl\":\"https://your-vc-instance.com\",\"apiKey\":\"YOUR_API_KEY\",\"workspace\":\"your-store-id\"}",
"LOG_LEVEL": "info"
}
}
}
}
选项B：来源
git clone https://github.com/VirtoCommerce/mcp-onx.git
cd mcp-onx
# Build server first (adapter depends on it)
cd server && npm install && npm run build && cd ..
# Build adapter
cd virtocommerce-adapter && npm install && npm run build && cd ..
然后添加到Claude Desktop配置中：
{
"mcpServers": {
"cof-mcp": {
"command": "node",
"args": ["/absolute/path/to/server/dist/index.js"],
"env": {
"ADAPTER_TYPE": "local",
"ADAPTER_PATH": "/absolute/path/to/virtocommerce-adapter/dist/index.js",
"ADAPTER_CONFIG": "{\"apiUrl\":\"https://your-vc-instance.com\",\"apiKey\":\"YOUR_API_KEY\",\"workspace\":\"your-store-id\"}",
"LOG_LEVEL": "info"
}
}
}
}
配置
| 选项 | 类型 | 必填 | 默认 | 描述 |
|---|---|---|---|---|
apiUrl |
string |
是 | -- | VirtoCommerce平台URL |
apiKey |
string |
是 | - | neneneba API密钥(api_key 头球 |
workspace |
string |
否 | -- | 门店ID--范围订单/发货，自动检测目录 |
catalogId |
string |
没有 | -- | 产品搜索的目录ID（如果从商店自动检测到 workspace 已设置） |
timeout |
number |
没有 | 30000 |
请求超时（毫秒） |
retryAttempts |
number |
没有 | 3 |
失败请求的最大重试次数 |
debugMode |
boolean |
没有 | false |
将所有API请求/响应记录到stderr |
VirtoCommerce权限
适配器需要以下VirtoCommerce API权限：
- 订单：读取、搜索、创建、更新
- 运输：搜索
- 客户/会员：阅读、搜索
- 目录：搜索
- 库存：搜索
- 平台：阅读（国家列表）
- 商店：阅读（当
workspace已设置） - 定价：评估（可选--用于在订单创建过程中自动查找价格）
看 docs/PERMISSIONS.md 查看详细的权限映射。
文档
- 快速入门指南 --带屏幕截图的分步设置
- 配置参考 --所有选项、环境变量、重试逻辑
- API 参考 --端点映射、状态映射、过滤器/搜索映射
- 权限 --每次操作所需的VirtoCommerce权限
- 已知限制 --未实现的功能和解决方法
发展
cd virtocommerce-adapter
npm run build # tsc → dist/
npm run dev # tsc --watch
npm test # Jest with --experimental-vm-modules
npm run lint # ESLint
备注：构建服务器(
cd server && npm run build)在构建适配器之前，这取决于@cof-org/mcp通过file:../server.
许可证
看 许可证 在存储库根目录中。
