Clover Mcp

🚀 Clover MCP（模型上下文协议）服务器

Clover MCP服务器是一个使用OAuth身份验证与Clover API交互的最小MCP服务器，它允许生成式AI模型和其他客户端通过Model Context Protocol访问您的Clover商家数据。

🚀 快速开始

使用Claude AI（推荐）

1. 将以下内容添加到您的Claude MCP设置中（通常位于~/.config/anthropic/claude.mcp.json）：

{
"mcpServers": {
"clover": {
"command": "npx",
"args": ["-y", "@ibraheem4/clover-mcp"],
"env": {
"CLOVER_CLIENT_ID": "your-clover-client-id",
"CLOVER_CLIENT_SECRET": "your-clover-client-secret",
"CLOVER_BASE_URL": "https://apisandbox.dev.clover.com"
},
"disabled": false,
"autoApprove": ["initiate_oauth_flow", "get_merchant_info", "list_inventory", "list_orders"]
}
}
}

2. 使用Claude时：

/mcp use clover

3. 在与Claude的对话中启动OAuth流程：

你能帮我连接到我的Clover账户吗？

命令行使用

您可以直接运行MCP服务器：

# 一次安装并运行
npx @ibraheem4/clover-mcp

# 带有凭证
CLOVER_CLIENT_ID=your-client-id CLOVER_CLIENT_SECRET=your-client-secret npx @ibraheem4/clover-mcp

✨ 主要特性

此MCP服务器允许生成式AI模型和其他客户端通过Model Context Protocol访问您的Clover商家数据，模型可以：

• 获取商家信息
• 列出库存商品
• 列出订单
• 访问单个商品和订单

📦 安装指南

Clover OAuth设置

使用此MCP服务器之前，需要设置Clover应用：

1. 在developer.clover.com创建Clover开发者账户
2. 在Clover开发者仪表盘中注册新应用
3. 配置您的应用：
   • 站点URL：http://localhost:4000/oauth-callback
   • 默认OAuth响应：Code
4. 记下您的客户端ID和客户端密码
5. 将这些凭证添加到环境变量或.env文件中

本地安装

1. 克隆此仓库
2. 安装依赖项：

npm install

3. 设置OAuth凭证：

cp .env.example .env
# 使用您的Clover OAuth凭证编辑.env文件

4. 构建TypeScript代码：

npm run build

5. 启动服务器：

npm start

💻 使用示例

与Claude一起使用示例

以下是可用于Claude的一些示例提示：

基础用法

# 连接到Clover
你能帮我连接到我的Clover账户吗？

# 获取商家信息
您有关于我的Clover商家账户的信息吗？

# 列出库存商品
显示我库存中的前10个项目。

# 列出订单
您能列出我最近的订单吗？

📚 详细文档

MCP工具

以下工具可通过MCP协议使用：

• get_oauth_status：检查OAuth凭证是否可用
• initiate_oauth_flow：启动OAuth流程以获取访问令牌
• get_merchant_info：获取商家信息
• list_inventory：列出库存商品，带可选过滤器
• list_orders：列出订单，带可选过滤器

🔧 技术细节

故障排除

• 确保您已正确设置环境变量CLOVER_CLIENT_ID和CLOVER_CLIENT_SECRET
• 验证API请求是否成功，查看控制台输出

📄 许可证

此项目受MIT License保护。