MCP 开发规范：从基础到实践的全面指南

一、基础规范：构建代码的"语言体系"

1.1 命名体系

在MCP项目中，命名就像给每个代码元素贴上清晰的标签，帮助开发者快速理解其用途。我们需要遵循三级命名规则：

项目命名

采用PascalCase命名法，如Azure.Mcp.Server。这种命名方式能清晰体现项目的层级关系和所属领域。

文件命名

• C#源代码文件使用PascalCase，例如AppConfigSetup.cs
• 配置文件使用kebab-case，如appsettings.Development.json

目录命名

• 测试项目目录以.Tests结尾，如Azure.Mcp.Core.UnitTests
• 功能模块目录使用清晰的英文名称，如Commands、Services等

⚠️ 命名禁忌：禁止使用拼音或无意义的缩写作为命名，确保名称能准确反映其功能。

命名规范是代码可读性的第一扇门，良好的命名能让代码自文档化，减少沟通成本。

二、核心架构：工具包的分层收纳

2.1 核心模块解析

MCP项目的核心模块就像工具包的基础组件，位于[core/]目录下，为整个项目提供基础支撑：

• 命令系统：[core/Azure.Mcp.Core/src/Commands/]，负责定义和处理各种命令
• 配置管理：[core/Azure.Mcp.Core/src/Configuration/]，处理项目的配置信息
• 服务接口：[core/Azure.Mcp.Core/src/Services/]，提供各种业务服务

这些核心模块相互协作，构成了MCP项目的基础框架。

2.2 工具项目标准结构

每个工具项目都遵循统一的结构，就像一套标准的工具箱，让开发者能快速找到所需的工具：

工具项目/
├── src/
│   ├── Commands/       # 命令定义
│   ├── Models/         # 数据模型
│   ├── Options/        # 命令行选项
│   ├── Services/       # 业务逻辑
│   └── 工具入口.cs     # 如 AksSetup.cs
└── tests/              # 测试代码

这张架构示意图展示了MCP工具间的调用关系和数据流，体现了开发规范中的模块化设计思想。

清晰的架构是项目可维护性的基础，合理的模块划分能让代码更易于扩展和修改。

三、实践指南：从零开始的开发旅程

3.1 环境搭建

搭建MCP开发环境只需三个简单步骤：

1. 克隆仓库：git clone https://gitcode.com/GitHub_Trending/mcp27/mcp
2. 安装依赖：运行[eng/scripts/Install-GitHooks.ps1]
3. 配置开发环境：参考[docs/bug-bash/installation-testing.md]

3.2 开发流程

MCP工具的开发流程就像制作一件精密仪器，需要按部就班，确保每个环节的质量：

1. 创建工具项目，遵循前面提到的命名规范
2. 实现命令逻辑，继承CommandBase类
3. 添加单元测试，确保代码质量
4. 运行测试：dotnet test
5. 构建项目：dotnet build

这张图片展示了在VS Code中安装MCP Server扩展的界面，是开发流程中的一个重要环节。

遵循标准的开发流程，能提高开发效率，减少错误，确保项目质量。

四、质量保障：打造可靠的代码产品

4.1 代码质量

代码质量是项目的生命线，MCP项目通过以下方式确保代码质量：

• 遵循[Microsoft 代码规范]
• 使用[eng/scripts/Analyze-Code.ps1]进行代码分析
• 确保测试覆盖率达到80%以上

建议定期进行代码审查，及时发现和修复潜在问题。

4.2 文档标准

良好的文档是项目易用性的关键，MCP项目的文档标准包括：

• 每个工具需提供详细的使用文档，放在工具目录下的README.md
• API文档使用XML注释生成
• 变更日志遵循[Keep a Changelog]规范，存放在[servers/Azure.Mcp.Server/changelog-entries/]

变更日志示例：

- 类型: 功能
  描述: 添加了新的Aks命令
  作者: 开发者姓名
  日期: 2023-10-01

文档是项目的"用户手册"，完善的文档能降低使用门槛，提高项目的可用性。

通过遵循以上规范和实践，你将能够开发出高质量、一致性强的MCP工具，为云平台生态系统贡献力量。记住，规范不是束缚，而是帮助我们更高效地协作和创造的工具。