xiaozhi-mcp

# xiaozhi MCP Aggregate | 小智 MCP 集合项目 A powerful interface for extending AI capabilities through remote control, calculations, email operations, knowledge search, and more. ## Overview | 概述 MCP (Model Context Protocol) is a protocol that allows servers to expose tools that can be invoked by language models. Tools enable models to interact with external systems, such as querying databases, calling APIs, or performing computations. Each tool is uniquely identified by a name and includes metadata describing its schema. ## Tools | 工具集 - **conversation_dingtalk**: Send conversation to dingtalk | 将会话内容发送到钉钉群机器人 - **email_qq**: Send email with qq mail account | 使用QQ邮箱发送邮件 - **system**: Get server status | 获取服务器状态监控信息包含 CPU、内存、磁盘等使用情况 - **web_webpilot**: Web search by WebPilot | 通过 WebPilot 实现联网搜索 ## Features | 特性 - 🔌 Bidirectional communication between AI and external tools | AI与外部工具之间的双向通信 - 🔄 Automatic reconnection with exponential backoff | 具有指数退避的自动重连机制 - 📊 Real-time data streaming | 实时数据流传输 - 🛠️ Easy-to-use tool creation interface | 简单易用的工具创建接口 - 🔒 Secure WebSocket communication | 安全的WebSocket通信 ## Quick Start | 快速开始 1. Install dependencies | 安装依赖: ```bash python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt ``` 2. Set up environment variables | 设置环境变量: ```bash # Copy the .env.example file to your own configuration file, e.g., .env.xiaozhi1 # 参考 .env.example 文件,复制到你自己的配置文件例如 .env.xiaozhi1 ``` 3. Run the example | 运行示例: ```bash # You can run different XiaoZhi MCP access points through different configuration files # 可以通过不同的配置文件，来运行到不同的多个小智MCP接入点 python mcp_pipe.py aggregate.py --env-file .env.xiaozhi1 ``` ## Creating Your Own MCP Tools | 创建自己的MCP工具 Here's a simple example of creating an MCP tool | 以下是一个创建MCP工具的简单示例: - According to the example in the tools folder, create your own tool | 根据 tools 文件夹中的示例创建自己的工具 - The tool name is distinguished by function_channel, for example, email_google indicates that it is a Google Mail MCP tool | 工具命名以 功能_渠道区分，例如 email_google 表明是谷歌邮箱的MCP工具 - Register your tool in aggregate.py | 在 aggregate.py 中注册你的工具 - Configure the environment variables for your tool in the .env.xxx file (if any) | 在 .env.xxx 文件中配置你的工具的环境变量(如果有的话) - If you want to contribute code, you also need to add the environment variables for your tool (if any) in the .env.example file | 如果要贡献代码的话还需要在 .env.example 文件中添加你的工具的环境变量（如果有的话） ## Use Cases | 使用场景 - Mathematical calculations | 数学计算 - Email operations | 邮件操作 - Knowledge base search | 知识库搜索 - Remote device control | 远程设备控制 - Data processing | 数据处理 - Custom tool integration | 自定义工具集成 ## Requirements | 环境要求 - Python 3.10+ - websockets>=11.0.3 - python-dotenv>=1.0.0 - mcp>=1.8.1 - pydantic>=2.11.4 ## FAQ | 常见问题 - MCP_PIPE - ERROR - Connection error: python-socks is required to use a SOCKS proxy ```text 关闭电脑的系统代理 Close the system proxy on your computer ``` ## Contributing | 贡献指南 Contributions are welcome! Please feel free to submit a Pull Request. ## License | 许可证 This project is licensed under the MIT License - see the LICENSE file for details. ## Acknowledgments | 致谢 - https://github.com/78/mcp-calculator | 完全根据78前辈的计算器mcp，做的外扩 - Thanks to all contributors who have helped shape this project | 感谢所有帮助塑造这个项目的贡献者 - Inspired by the need for extensible AI capabilities | 灵感来源于对可扩展AI能力的需求