AWS MCP Servers社区贡献者指南：如何参与开源项目并提交代码
项目地址: https://gitcode.com/GitHub_Trending/mcp15/mcp 你是否想为AWS MCP Servers项目贡献代码但不知从何入手？本文将带你通过6个步骤完成从环境配置到代码提交的完整流程，让你轻松成为开源贡献者。读完本文后，你将能够：搭建本地开发环境、创建或改进MCP服务器、编写测试用例、提交Pull Request，并遵循社区规范参与项目开发。
贡献前准备
在开始贡献前，请确保你已了解项目的基本规范和要求。首先，阅读项目根目录下的贡献指南和开发者指南，这两份文档详细说明了贡献流程和技术要求。同时，项目采用了Amazon开源行为准则，所有贡献者需遵守其中规定的行为规范。
环境配置步骤
| 工具/软件 | 版本要求 | 安装说明 |
|---|---|---|
| Python | 3.10+ | 推荐使用uv python install 3.10安装 |
| uv | 最新版 | 参考uv安装文档 |
| pre-commit | 最新版 | 通过pip install pre-commit安装 |
| Git | 最新版 | 参考Git安装指南 |
代码仓库获取
首先，访问项目仓库并Fork到个人账号：
git clone https://gitcode.com/GitHub_Trending/mcp15/mcp.git
cd mcp
pre-commit install # 安装代码检查钩子
开发流程详解
1. 创建新MCP服务器
项目提供了Cookiecutter模板来快速创建新的MCP服务器。在项目根目录执行以下命令：
uvx cookiecutter https://gitcode.com/GitHub_Trending/mcp15/mcp.git --checkout cookiecutters --output-dir ./src --directory python
根据提示输入服务器名称、描述等信息，模板将自动生成基础代码结构。生成的服务器代码位于src/your-server-name-mcp-server目录下，例如AWS Documentation MCP Server就是使用该模板创建的。
2. 开发与测试
目录结构规范
新服务器应遵循以下目录结构：
src/your-server-name-mcp-server/
├── awslabs/ # 源代码目录
├── tests/ # 测试用例目录
├── README.md # 服务器说明文档
├── pyproject.toml # 依赖配置文件
└── Dockerfile # 容器化配置
依赖管理
使用uv管理Python依赖：
cd src/your-server-name-mcp-server
uv add requests # 添加依赖
uv sync --all-groups # 同步依赖
本地测试
修改客户端配置文件，指向本地开发服务器：
"awslabs.your-server-name-mcp-server": {
"command": "uv",
"args": [
"--directory",
"/path/to/your/server/code",
"run",
"server.py"
]
}
使用MCP Inspector工具调试服务器：
npx @modelcontextprotocol/inspector uv --directory /path/to/server run server.py
单元测试
每个服务器必须包含单元测试，存放在tests目录下。以AWS Documentation MCP Server为例，其测试文件位于src/aws-documentation-mcp-server/tests。运行测试命令：
uv run --frozen pytest --cov --cov-branch --cov-report=term-missing
3. 文档更新
新增或修改服务器后，需更新相关文档：
- 在服务器目录下创建或更新README.md，说明功能和使用方法
- 在项目根目录README.md的"Available MCP Servers"部分添加服务器介绍
- 为新服务器在docusaurus/docs/servers目录下创建文档页面
代码提交规范
分支管理
创建功能分支进行开发：
git checkout -b feature/your-feature-name
提交信息格式
推荐使用Conventional Commits规范，例如：
git commit -m "feat(server): add new AWS Lambda MCP server"
代码检查
提交前运行代码检查：
pre-commit run --all-files
如遇到密钥检测失败，可运行以下命令处理：
detect-secrets scan --baseline .secrets.baseline
detect-secrets audit .secrets.baseline
Pull Request流程
创建Pull Request
- 将本地分支推送到个人Fork仓库：
git push origin feature/your-feature-name
-
在GitCode平台创建Pull Request，目标分支为
main -
PR描述应包含：
- 功能或修复说明
- 测试方法
- 相关文档更新情况
PR审核与合并
项目维护者会审核你的PR，可能会提出修改意见。请及时回应并更新代码。CI检查通过且审核通过后，你的代码将被合并到主分支。
贡献示例：AWS Documentation MCP Server
AWS Documentation MCP Server是一个完整的贡献示例，其目录结构如下：
src/aws-documentation-mcp-server/
├── awslabs/ # 核心代码
├── tests/ # 测试用例
├── basic-usage.gif # 使用演示动画
└── README.md # 使用文档
该服务器实现了AWS文档查询功能，其代码结构和开发流程可作为贡献参考。
社区资源
- 问题跟踪：通过项目Issue页面查找"help wanted"标签的任务
- 示例代码：参考samples目录下的集成示例
- 开发规范：遵循设计指南中的架构要求
- 交流渠道：通过项目Discussions页面参与讨论
总结
通过本文介绍的步骤，你已经掌握了参与AWS MCP Servers项目的完整流程。记住，开源贡献从小处着手，即使是修复一个错别字或改进文档也是有价值的。立即行动起来：Fork项目仓库，搭建开发环境，选择一个issue开始贡献吧！
如果你有任何问题，欢迎在项目仓库提交issue或参与讨论。期待你的第一个Pull Request！
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
