Bring MCP Server

Bring MCP 服务器

一个模型上下文协议（MCP）服务器，可与 Bring 购物清单 API 集成，让 AI 助手通过自然语言管理购物清单。

免责声明： 本项目使用未公开记录或支持的非官方 Bring API。这些 API 可能会在不另行通知的情况下发生变化，导致功能无法正常使用。使用风险自负。

概述

本项目使用 TypeScript 实现了一个功能齐全的模型上下文协议（MCP）服务器，可连接 Bring 购物清单 API。它支持 Claude、ChatGPT 等 AI 助手通过标准化协议与您的 Bring 购物清单交互。

功能

• MCP 协议支持：实现模型上下文协议，可与 AI 助手无缝集成
• Stdio 传输：兼容 Claude for Desktop 和其他支持 MCP 的客户端
• Bring API 集成：完整集成 Bring 购物清单 API，支持以下功能：
  • 列出所有购物清单
  • 获取购物清单中的项目
  • 向购物清单添加食谱项目
  • 移除指定项目或清空整个购物清单
  • 获取清单项目的详细信息
  • 查看所有有权访问购物清单的用户

前置条件

• Bring 账号（电子邮件和密码）
• Bring API 密钥

安装

1. 克隆代码库：

   git clone <repository-url>
   cd bring-mcp-server
   

2. 安装依赖：

   npm install
   

3. 在项目根目录中创建 .env 文件，并添加以下变量：

   BRING_EMAIL=your_bring_account_email
   BRING_PASSWORD=your_bring_account_password
   BRING_API_KEY=your_bring_api_key
   

4. 构建项目：

   npm run build
   

使用方法

启动服务器

使用以下命令启动 MCP 服务器：

node dist/index.js

服务器将通过 stdio 连接，因此兼容 Claude for Desktop 等 MCP 客户端。

连接到 Claude for Desktop

1. 配置 Claude for Desktop 以使用此 MCP 服务器
2. 现在，您可以在 Claude 对话中与 Bring 购物清单交互

可用的 MCP 工具

该服务器向 MCP 客户端提供以下工具：

工具名称	描述
get-bring-lists	列出已验证用户的所有购物清单
get-bring-list-items	获取指定购物清单中的所有项目
add-recipe-items-to-bring-list	一次性向购物清单添加多个项目
remove-item-or-all-from-bring-list	移除指定项目或清空整个清单
get-bring-list-items-details	获取清单中项目的详细信息
get-all-users-from-bring-list	列出所有有权访问指定清单的用户

开发

在开发模式下运行

npm run dev

这会以热重载方式启动服务器，便于开发。

VS Code 集成

有关 VS Code 集成的信息，请参阅 .vscode/mcp.sample.json 文件。此配置允许 VS Code 直接连接到 MCP 服务器。

测试

使用以下命令运行完整的测试套件：

npm test

持续集成

本项目使用 GitHub Actions 进行持续集成。每次向 main 分支推送代码以及提交拉取请求时，都会运行自动化测试。

您可以在 .github/workflows/test.yml 中查看工作流配置。

测试结构

测试按以下结构组织在 test/ 目录中：

• handlers/ - 包含每个 MCP 工具处理器的测试
• mocks/ - 包含测试中使用的模拟实现

许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

---

如需提出功能请求或报告错误，请在项目代码库中提交 issue。