Chatterbox MCP Server

🚀 Chatterbox MCP 服务器

Chatterbox MCP 服务器是基于模型上下文协议（MCP）的前沿实现，专为个人使用量身打造。它就像一座桥梁，连接应用程序与强大的 AI 模型，让与 WhatsApp 等工具的通信无缝衔接。无论是开发聊天机器人、实现任务自动化，还是开展 AI 试验，这个服务器都是您的理想之选！

🚀 快速开始

克隆仓库

git clone https://github.com/your-repo/chatterbox_mcp_server.git
cd chatterbox_mcp_server

安装依赖项

npm install

开发模式下运行

npm run dev

构建并启动

npm run build
npm start

使用 Docker 运行

npm run docker:local

✨ 主要特性

• 动态资源管理：借助 MCP 框架，轻松完成资源的注册与管理。
• WhatsApp 集成：可以获取和发送 WhatsApp 消息，还能利用内置工具轻松查找联系人信息。
• 环境驱动配置：通过灵活的部署方式，安全地管理和配置密钥及环境变量。
• Stdio 传输：通过标准输入输出进行通信，既简单又便于携带。
• Docker 就绪：可轻松在容器化环境中部署服务器。

🔧 技术细节

该项目运用了以下技术，构建出强大且可扩展的解决方案：

• TypeScript：保障类型安全，支持现代 JavaScript 功能。
• Node.js：提供快速高效的运行时环境。
• 模型上下文协议 SDK：为服务器的核心功能提供支持。
• Zod：用于验证工具和资源的输入模式。
• Express：简化 HTTP 服务器的创建和路由设置。
• Docker：实现容器化部署，确保环境的一致性。
• Nodemon：支持实时开发，可自动重启。

📚 详细文档

📂 项目结构

以下是项目结构的简要介绍：

src/
    src/server.ts          # 主服务器入口点
    model/
        src/model/resources.ts   # 资源注册逻辑
        src/model/tools.ts       # 工具注册逻辑（例如 WhatsApp 工具）
    types/
        src/types/types.ts       # 项目类型定义
secrets/               # 安全环境变量文件
.vscode/               # VS Code 配置文件
package.json           # 项目元数据和脚本
tsconfig.json          # TypeScript 配置
dockerfile             # Docker 配置用于容器化
README.md              # 您正在阅读它！

🌐 WhatsApp 工具

基础用法

检索消息

为特定电话号码获取未读消息：

{
  "phoneNumber": "+1234567890",
  "numberOfRecords": "5"
}

发送消息

向特定电话号码发送消息：

{
  "phoneNumber": "+1234567890",
  "message": "来自 Chatterbox MCP 服务器的问候！"
}

检索用户

通过姓名查找 WhatsApp 用户并获取其 WhatsApp ID：

{
  "contactName": "John Doe"
}

📄 许可证

该项目遵循 MIT 许可证发布，您可以自由使用、修改和分享！

💬 反馈与贡献

我们期待您的声音！欢迎提出问题或提交拉取请求，为项目贡献力量。

祝您编码愉快！🎉