JinDaGe - chatterbox_mcp_server MCP Details

article

README

🚀 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"
}

🤖 为什么选择 Chatterbox MCP 服务器？

这个项目不仅仅是一个服务器——它是创新的试验场。无论是开发人员探索 AI 集成，还是业余爱好者自动化工作流程，Chatterbox MCP 服务器 激励您将想法变为现实。

📄 许可证

该项目根据 MIT 许可证发布。您可随意使用、修改和分享！

💬 反馈与贡献

我们很乐意听到您的声音！您可随意打开问题或提交拉取请求以对项目做出贡献。

祝您编码愉快！🎉

chatterbox_mcp_server