使用说明
MCP服务器管理存储库
此仓库是一个单体仓库,用于统一管理Model Context Protocol(MCP)服务器的实现。
📚 概述
MCP是一种用于连接AI应用程序与数据源和工具的标准化协议。本存储库提供了模板、文档和工具,以便高效地开发和管理多个MCP服务器。
🚀 快速入门
创建新的MCP服务器
# 1. テンプレートをコピー
cp -r template/ servers/your-server-name/
cd servers/your-server-name/
# 2. uvがインストールされていない場合はインストール
curl -LsSf https://astral.sh/uv/install.sh | sh
# 3. セットアップスクリプトを実行(推奨)
./quickstart.sh
# または手動でセットアップ
uv venv
source .venv/bin/activate # Linux/Mac
# または .venv\Scripts\activate (Windows)
uv pip install -e ".[dev]"
# 4. サーバーを起動
python server.py
详细步骤为 MCP服务器构建指南 请参考。
📁 目录结构
mcp/
├── docs/ # ドキュメント
│ └── MCP_SERVER_GUIDE.md # 詳細な構築ガイド
├── template/ # 新規サーバー用テンプレート
│ ├── server.py # サーバーテンプレート
│ ├── config.json # 設定テンプレート
│ ├── requirements.txt # 依存関係
│ ├── tests/ # テストテンプレート
│ └── utils/ # ユーティリティ
├── servers/ # 各MCPサーバー実装
│ └── [server-name]/ # 個別のサーバープロジェクト
├── examples/ # サンプル実装
│ ├── calculator_server.py # 計算機サーバーの例
│ └── README.md # 例の説明
├── AGENTS.md # GitHub Copilot 設定
└── README.md # このファイル
📖 文档
主要指南
- **MCP服务器构建指南**MCP服务器的创建步骤、启动方法及最佳实践
- **开发指南**开发工作流程、调试、测试策略
- **快速参考**常用的命令和代码片段
- **贡献指南**为项目做贡献的方式
设置与参考
- **AGENTS.md 翻译为中文是:“代理列表.md” 或 “代理商文件.md”(具体翻译可能根据上下文有所调整,但“AGENTS”通常指代理或代理商)**GitHub Copilot的系统提示和编码规范
- **项目结构**项目的整体结构和各个文件的作用
- **文档索引**所有文档的链接
模板与示例
🔧 主要功能
模板
- 即开即用的服务器模板包括必要的设置和样板代码
- 测试结构使用 pytest 的测试模板
- 效用函数常用函数的实现示例
文件
- 详细的设置指南分步操作指南
- 启动命令集开发及生产环境的启动方法
- 最佳实践安全、性能、测试指南
GitHub Copilot 支持
- **`AGENTS.md` 翻译为中文是:“代理列表.md” 或 “代理说明.md”(具体翻译可能根据上下文有所调整,但通常`AGENTS`一词在这里指的是代理或代表的列表或说明)**提升Copilot精度的系统提示
- 编码规范统一的代码风格
- 类型提示和文档更佳的代码补全
💡 示例
计算机服务器
提供简单计算功能的MCP服务器示例:
cd examples/
python calculator_server.py
详情如下 示例/README.md 请参考。
🛠️ 必备环境
- Python 3.10及以上版本
- 紫外线(推荐)或 pip
- Git(注:Git是一个分布式版本控制系统,用于跟踪对文件的修改,常用于软件开发中)
🎯 仓库管理任务
此存储库中提供了用于高效管理多个MCP服务器的任务文件。
Taskfile(推荐)
任务使用进行管理:
# Taskのインストール
brew install go-task/tap/go-task # macOS
# または https://taskfile.dev/installation/
# 利用可能なタスクを表示
task --list
# 新しいサーバーを作成
task new-server SERVER_NAME=my-server
# サーバーを実行
task run-server SERVER_NAME=my-server
# 全サーバーをテスト
task test-all
Makefile
使用make进行管理:
# ヘルプを表示
make help
# 新しいサーバーを作成
make new-server SERVER_NAME=my-server
# サーバーを実行
make run-server SERVER_NAME=my-server
# 全サーバーをテスト
make test-all
📝 开发指南
编码规范
- 遵循PEP 8规范
- 使用类型提示
- Google风格的docstring
- 异步处理的应用(async/await)
测试
# テストの実行
pytest tests/
# カバレッジ付き
pytest --cov=. tests/
代码质量
# フォーマット
black .
# リント
ruff check .
# 型チェック
mypy .
🤝 贡献
- 对此仓库进行派生
- 创建功能分支
git checkout -b feature/amazing-feature) - 提交更改(
git commit -m 'feat: Add amazing feature') - 向分支推送(
git push origin feature/amazing-feature) - 创建拉取请求
📚 参考资料
📄 许可证
有关此项目的许可信息,请参阅存储库中的许可文件。
📄 许可证
该项目根据 MIT 许可证发布。详情请见 许可证 请参考文件。
📋 更改历史
详细的变更历史记录 CHANGELOG.md 翻译成中文是:“变更日志文件(Markdown 格式)” 请参考。
💬 支持
如出现问题,可通过以下方式获得支持:
- **GitHub Issues(GitHub问题)**错误报告和功能请求
- 文件: MCP服务器指南.md 请参考
- 例(例如): 示例/ 查看目录的示例代码
