chuk-mcp-echo-server

🚀 MCP 回声服务器

MCP 回声服务器是一款基于 Python 的轻量级微服务，它能接收消息并将其原样返回给客户端。在 MCP 框架里，它可作为基础的诊断和测试工具，为开发者提供便利。

🚀 快速开始

运行服务器

命令行界面

chuk-mcp-echo-server

编程式使用

from chuk_mcp_echo_server.main import main

if __name__ == "__main__":
    main()

✨ 主要特性

• 消息回声：服务器会返回任何发送给它的消息。
• 全面验证：借助 Pydantic 模型，实现强大的输入验证功能。
• 异步服务器架构：基于 asyncio 构建，具备高效的性能。
• 灵活配置：支持通过环境变量和配置文件进行灵活配置。

📦 安装指南

先决条件

• Python 3.11 或更高版本
• pip
• （可选）推荐使用虚拟环境

从 PyPI 安装

pip install chuk-mcp-echo-server

从源代码安装

1. 克隆仓库：

git clone <repository-url>
cd chuk-mcp-echo-server

2. 创建虚拟环境：

python -m venv venv
source venv/bin/activate  # 在 Windows 上使用 `venv\Scripts\activate`

3. 安装包：

pip install .  # 以可编辑模式安装包

开发安装

若要设置开发环境，可执行以下命令：

pip install .[dev]  # 使用开发依赖项安装包

💻 使用示例

基础用法

from chuk_mcp_echo_server.main import main

if __name__ == "__main__":
    main()

高级用法

回声工具使用

# 输入一个字符串消息，服务器将返回包含该消息的 EchoResult 对象
echo("Hello, world!")

📚 详细文档

项目细节

| 属性 | 详情 | |------|------| | 版本 | 0.1.0 | | Python 兼容性 | Python 3.11+ |

依赖项

核心依赖项

• mcp (>=1.6.0)
• pydantic (>=2.11.2)
• PyYAML (>=6.0.2)

开发依赖项

• pytest (>=8.3.5)

环境变量

• NO_BOOTSTRAP：设置该变量可禁用组件启动引导，其他配置选项可在配置文件中设置。

🔧 技术细节

代码格式化

• 使用 Black 进行代码格式化。
• 使用 isort 进行导入排序。
• 行长度设置为 88 个字符。

运行测试

pytest

📄 许可证

本项目采用 MIT License。

🤝 贡献指南

1. 叉取仓库。
2. 创建功能分支 (git checkout -b feature/AmazingFeature)。
3. 确保代码通过格式检查和测试。
4. 提交更改 (git commit -m 'Add some AmazingFeature')。
5. 推送到分支 (git push origin feature/AmazingFeature)。
6. 打开 Pull Request。