dotnet-coverage-mcp

一个 MCP（模型上下文协议）服务器，让 AI 助手（如 Claude Code、Gemini CLI 等）直接访问 .NET 测试覆盖率工具。通过 stdio 运行 dotnet test、解析 Cobertura XML、识别未覆盖的分支、比较两次运行之间的覆盖率差异，并追加测试代码。

目的

该服务器让 AI 助手无需离开聊天即可运行单元测试、收集覆盖率数据并分析结果。AI 无需手动运行 dotnet test 和解析报告，而是可以直接调用服务器的工具来：

• 发现源文件并按行预算构建智能批次

• 运行一组筛选后的测试并收集覆盖率

• 读取紧凑、面向 AI 优化的覆盖率摘要（方法级行/分支覆盖率）

• 根据可配置的目标覆盖率（默认 80%）检查每个文件的覆盖率

• 以结构化 JSON 识别未覆盖的分支

• 比较两次运行之间的覆盖率差异，仅查看变化内容

• 以原子写入方式将新测试代码追加到现有测试文件

Related MCP server: codecov-mcp-server

工作原理

服务器以控制台进程启动，并通过 stdio 使用 MCP 协议进行通信。兼容 MCP 的客户端（如 Claude Code、Gemini CLI 等）启动该进程，并像调用函数一样调用其工具。

AI Client  <--stdio/MCP-->  dotnet-coverage-mcp  <--shell-->  dotnet test + reportgenerator

可用工具

批次工作流

对于包含许多源文件的项目，推荐的工作流程如下：

1. 发现 — 对文件夹或 .csproj 调用 GetSourceFiles 以获取所有文件和智能批次

2. 运行一次 — 使用宽泛过滤器（例如 *）调用 RunTestsWithCoverage 以收集所有文件的覆盖率

3. 逐文件检查 — 对当前批次中的每个文件调用 GetFileCoverage（即时 XML 解析，无需重新运行测试）

4. 聚焦 — 选择分支覆盖率最低的 3 个方法，并分别调用 GetUncoveredBranches

5. 编写测试 — 使用 AppendTestCode 添加测试方法

6. 重新运行并比较 — 运行一次测试，调用 GetCoverageDiff 验证改进

7. 重复 — 继续直到批次文件达到目标覆盖率（默认 80%）或连续 3 个周期无改进，然后移至下一批次

这最大限度地减少了 dotnet test 的调用次数（主要瓶颈），同时仍能跟踪每个文件的进度。

并发

多个 AI 代理可以通过向每个工具调用传递 sessionId 来并行运行，从而隔离各自的覆盖率工件：

• 隔离的输出目录 — RunTestsWithCoverage 为每个会话创建 TestResults-{hash}/ 和 coveragereport-{hash}/，防止一个代理在解析过程中删除另一个代理的 XML

• 作用域状态文件 — 覆盖率状态写入 .mcp-coverage/.coverage-state-{hash}，因此 ResolveCoberturaPath 为每个会话解析到正确的 XML

• 作用域基线 — GetCoverageDiff 为每个会话将基线存储为 .coverage-prev-{hash}.xml

• 原子写入 — 所有文件写入（状态文件和测试代码）都使用先写临时文件再重命名的方式，以防止因竞争条件或进程崩溃而损坏

限制 — 构建输出不按会话隔离。 sessionId 隔离的是覆盖率工件，而不是 .NET 构建。dotnet test 将目标项目编译到其共享的 obj/ 和 bin/ 目录中，这些目录不是按会话隔离的，因此两个代理同时对同一个测试项目运行 RunTestsWithCoverage 会在这些输出上发生冲突，并以 buildError 失败（例如 CS2012: 该文件正被另一个进程使用）。请针对不同的测试项目运行并行代理，或使用仓库的独立工作副本。只要它们的 dotnet test 构建不重叠，多个代理在一个项目上运行是可以的。

如果不使用 sessionId，工具将使用共享默认值——对于单代理使用是安全的。

要求

• .NET 9.0 SDK（或更高版本） — https://dotnet.microsoft.com/download

• reportgenerator 全局工具 — 服务器调用它来渲染覆盖率报告（在下面的 安装 步骤中安装）

• 兼容 MCP 的客户端（Claude Code、Gemini CLI 等）

• COVERAGE_MCP_ALLOWED_ROOT — 推荐设置。将其设置为你的仓库根目录，以限制每个工具的文件系统访问仅限于该子树。客户端传入的任何超出此根目录的路径都会被拒绝并返回 pathNotAllowed。如果未设置，服务器会记录一次警告并接受任何路径（向后兼容，但不推荐用于共享环境）。

  export COVERAGE_MCP_ALLOWED_ROOT=/path/to/your/repo

安装

从 NuGet 将服务器安装为全局 .NET 工具：

dotnet tool install --global dotnet-coverage-mcp

服务器依赖 reportgenerator 全局工具来渲染覆盖率报告——也请安装它：

dotnet tool install --global dotnet-reportgenerator-globaltool

安装后，dotnet-coverage-mcp 命令将位于你的 PATH 中。

构建与运行（从源代码）

cd <path-to-dotnet-coverage-mcp>

# Restore dependencies
dotnet restore

# Build
dotnet build

# Run
dotnet run

服务器将启动并等待通过 stdin/stdout 接收 MCP 消息。

MCP 客户端配置

安装全局工具（dotnet tool install --global dotnet-coverage-mcp）后， 将服务器注册到你的 MCP 客户端。将 COVERAGE_MCP_ALLOWED_ROOT 设置为 你希望服务器操作的仓库。

Claude Code

claude mcp add coverage --env COVERAGE_MCP_ALLOWED_ROOT=/path/to/your/repo -- dotnet-coverage-mcp

Claude Desktop

添加到 claude_desktop_config.json（设置 → 开发者 → 编辑配置）：

{
  "mcpServers": {
    "coverage": {
      "command": "dotnet-coverage-mcp",
      "env": {
        "COVERAGE_MCP_ALLOWED_ROOT": "/path/to/your/repo"
      }
    }
  }
}

Cursor

添加到 ~/.cursor/mcp.json（全局）或 .cursor/mcp.json（项目级）：

{
  "mcpServers": {
    "coverage": {
      "command": "dotnet-coverage-mcp",
      "env": {
        "COVERAGE_MCP_ALLOWED_ROOT": "/path/to/your/repo"
      }
    }
  }
}

VS Code (GitHub Copilot)

添加到 .vscode/mcp.json：

{
  "servers": {
    "coverage": {
      "type": "stdio",
      "command": "dotnet-coverage-mcp",
      "env": {
        "COVERAGE_MCP_ALLOWED_ROOT": "/path/to/your/repo"
      }
    }
  }
}

从源代码运行

要从源代码运行而不是使用全局工具，请使用 dotnet run：

{
  "mcpServers": {
    "coverage": {
      "command": "dotnet",
      "args": ["run", "--project", "<path-to-dotnet-coverage-mcp>"],
      "transport": "stdio"
    }
  }
}

或直接指向编译后的可执行文件：

{
  "mcpServers": {
    "coverage": {
      "command": "<path-to-dotnet-coverage-mcp>\\bin\\Debug\\net9.0\\DotNetCoverageMcp.exe",
      "transport": "stdio"
    }
  }
}

工具参数

GetSourceFiles

RunTestsWithCoverage

GetCoverageSummary

GetFileCoverage

GetUncoveredBranches

GetCoverageDiff

AppendTestCode

CleanupSession

状态文件

所有状态文件都写入工作目录下的 .mcp-coverage/ 子目录中，保持项目根目录干净。请将 .mcp-coverage/ 添加到目标仓库的 .gitignore 中。

插件（技能与代理）

此仓库包含一个 plugin/ 目录，其中包含用于引导测试覆盖率工作流的 Claude Code 技能和代理定义：

plugin/
├── plugin.json
├── agents/
│   └── test-coverage.agent.md
└── skills/
    ├── scaffold-test-files/     — Create test directories and files mirroring source structure
    ├── run-coverage/            — Run tests and view coverage reports
    ├── analyze-coverage-gaps/   — Find uncovered branches and compare diffs
    └── improve-test-coverage/   — Iterative loop to reach 80% coverage

这些技能支持 NUnit、xUnit 和 MSTest，并在 references/unit.md 和 references/integration.md 中提供了与框架无关的参考文档。

依赖项

安全

dotnet-coverage-mcp 作为本地 stdio 进程运行，并会对 COVERAGE_MCP_ALLOWED_ROOT 校验所有工具参数，以限制对文件系统的访问。有关威胁模型、加固建议以及漏洞报告方式，请参阅 SECURITY.md。

参与贡献

我们欢迎各种贡献。有关开发环境搭建、拉取请求指南以及代码规范，请参阅 CONTRIBUTING.md。重要的变更记录在 CHANGELOG.md 中。

发布

仅限维护者——发布流程、NuGet 发布以及 MCP 注册表提交都记录在 RELEASING.md 中。