Test Coverage MCP

🚀 測試覆蓋率MCP

讓你的代碼編寫代理在編碼時具備覆蓋率感知能力

本項目的 MCP 服務器可以為任何編程語言（基於 LCOV）提供即時、可靠且節省令牌的測試覆蓋率數據，解決了 AI 編碼代理在缺乏適當覆蓋率工具時面臨的問題。

🚀 於 2025 年 11 月剛剛發佈！這些天我一直在精心打磨這個庫。如果你覺得它有價值，給個 ⭐ 星標可以讓其他開發者知道這個項目值得關注。

🚀 快速開始

當 AI 編碼代理在沒有適當覆蓋率工具的情況下處理代碼時，會面臨三個關鍵問題，而本 MCP 服務器提供瞭解決方案。你可以通過簡單的工具調用檢查覆蓋率、獲取覆蓋率摘要，並進行會話進度的基線跟蹤。

✨ 主要特性

• 覆蓋率感知：代理可以隨時通過簡單的工具調用檢查覆蓋率。
• 節省令牌：用少於 100 個令牌獲取覆蓋率摘要，而非數千個。
• 準確性：採用生產級的 LCOV 解析，處理所有格式變體。
• 基線跟蹤：在會話中測量覆蓋率進度，無需在內存中保存狀態。

📦 安裝指南

npm install -g test-coverage-mcp

💻 使用示例

基礎用法

1. 查詢覆蓋率摘要

詢問項目的整體覆蓋率或特定文件的覆蓋率：

// 獲取項目整體覆蓋率
coverage_summary({ lcovPath: "./coverage/lcov.info" });
// 返回: { linesCoveragePercentage: 87.5, branchesCoveragePercentage: 82.1 }

// 獲取特定文件的覆蓋率
coverage_file_summary({
  lcovPath: "./coverage/lcov.info",
  filePath: "src/utils/parser.ts",
});
// 返回: { path: "src/utils/parser.ts", linesCoveragePercentage: 92.0, branchesCoveragePercentage: 88.5 }

2. 會話進度的基線跟蹤

在會話開始時建立基線，然後測量進度：

// 會話開始時 - 將當前覆蓋率記錄為基線
start_recording({ lcovPath: "./coverage/lcov.info" });
// 返回: "Recording started"

// ... 代理編寫代碼和測試 ...

// 檢查覆蓋率影響
get_diff_since_start({ lcovPath: "./coverage/lcov.info" });
// 返回: { linesPercentageImpact: +2.3, branchesPercentageImpact: +1.8 }

高級用法

示例 1：開始工作前檢查覆蓋率

代理: "在開始工作前，讓我檢查一下當前的測試覆蓋率"
[使用 coverage_summary 工具]
代理: "當前的覆蓋率是 87.5% 的行覆蓋率和 82.1% 的分支覆蓋率。我會努力保持或提高這個水平。"

示例 2：開發過程中跟蹤覆蓋率影響

代理: "我先記錄基線覆蓋率"
[使用 start_recording 工具]

代理: "現在我將添加新的身份驗證功能並編寫測試"
[編寫代碼和測試]

代理: "讓我檢查一下覆蓋率的影響"
[使用 get_diff_since_start 工具]
代理: "太棒了！行覆蓋率提高了 2.3%，分支覆蓋率提高了 1.8%。"

示例 3：驗證特定文件的覆蓋率

代理: "讓我檢查一下我剛剛修改的文件的覆蓋率"
[使用 coverage_file_summary 工具，filePath: "src/auth/validator.ts"]
代理: "validator.ts 文件現在的行覆蓋率為 95%，分支覆蓋率為 92%。"

📚 詳細文檔

可用工具

coverage_summary

從 LCOV 文件中獲取項目的整體覆蓋率。 輸入：

{
  lcovPath?: string  // 可選。默認為 "./coverage/lcov.info"
}

輸出：

{
  linesCoveragePercentage: number,      // 0 - 100
  branchesCoveragePercentage: number    // 0 - 100
}

示例：

coverage_summary({ lcovPath: "./coverage/lcov.info" });
// { linesCoveragePercentage: 87.5, branchesCoveragePercentage: 82.1 }

coverage_file_summary

獲取特定文件的覆蓋率。 輸入：

{
  lcovPath?: string,  // 可選。默認為 "./coverage/lcov.info"
  filePath: string    // 必需。文件路徑
}

輸出：

{
  path: string,
  linesCoveragePercentage: number,      // 0 - 100
  branchesCoveragePercentage: number    // 0 - 100
}

示例：

coverage_file_summary({
  lcovPath: "./coverage/lcov.info",
  filePath: "src/utils/parser.ts",
});
// { path: "src/utils/parser.ts", linesCoveragePercentage: 92.0, branchesCoveragePercentage: 88.5 }

start_recording

將當前覆蓋率記錄為基線，以便後續比較。 輸入：

{
  lcovPath: string; // 必需。要記錄的 LCOV 文件的路徑
}

輸出：

"Recording started";

示例：

start_recording({ lcovPath: "./coverage/lcov.info" });
// "Recording started"

get_diff_since_start

將當前覆蓋率與記錄的基線進行比較。 輸入：

{
  lcovPath: string; // 必需。當前 LCOV 文件的路徑
}

輸出：

{
  linesPercentageImpact: number,      // 正數 = 改進，負數 = 下降
  branchesPercentageImpact: number    // 正數 = 改進，負數 = 下降
}

示例：

get_diff_since_start({ lcovPath: "./coverage/lcov.info" });
// { linesPercentageImpact: +2.3, branchesPercentageImpact: +1.8 }

配置

將此 MCP 服務器添加到你的 AI 編碼工具的配置中：

Claude Desktop (Claude Code)

macOS：編輯 ~/Library/Application Support/Claude/claude_desktop_config.json Windows：編輯 %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "test-coverage": {
      "command": "npx",
      "args": ["-y", "test-coverage-mcp"]
    }
  }
}

更新後，重啟 Claude Desktop。

Cursor IDE

在項目根目錄下創建或編輯 .cursor/mcp.json：

{
  "mcpServers": {
    "test-coverage": {
      "command": "npx",
      "args": ["-y", "test-coverage-mcp"]
    }
  }
}

GitHub Copilot (VS Code)

在工作區中創建或編輯 .vscode/mcp.json：

{
  "servers": {
    "test-coverage": {
      "command": "npx",
      "args": ["-y", "test-coverage-mcp"]
    }
  }
}

需要 VS Code 1.99+ 或 Visual Studio 17.14+。企業用戶需要啟用 "MCP servers in Copilot" 策略。

Windsurf (Codeium IDE)

macOS：編輯 ~/.codeium/windsurf/mcp_config.json Windows：編輯 %APPDATA%\Codeium\Windsurf\mcp_config.json Linux：編輯 ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "test-coverage": {
      "command": "npx",
      "args": ["-y", "test-coverage-mcp"]
    }
  }
}

或者使用圖形界面：設置 → 高級設置 → 級聯 → 添加服務器

🔧 技術細節

工作原理

本 MCP 服務器：

1. 解析 LCOV 文件：使用生產級解析器處理所有 LCOV 格式變體。
2. 計算覆蓋率：計算項目整體或單個文件的覆蓋率百分比。
3. 存儲基線：在臨時目錄中存儲基線，用於基於會話的跟蹤。
4. 返回緊湊 JSON：返回佔用最少令牌的緊湊 JSON 響應。

LCOV 格式支持

本服務器支持所有標準 LCOV 文件格式，包括：

• 包含摘要部分的文件（SF:，end_of_record）
• 僅包含逐行數據的文件（DA: 條目）
• 包含分支覆蓋率數據的文件（BRDA:，BRF:，BRH:）
• 同一文件中的混合格式

📄 許可證

MIT © Yoni Goldberg

🔗 鏈接

• GitHub 倉庫
• npm 包
• MCP 文檔
• 報告問題

💡 改進建議

• coverage_file_summary 返回的嵌套屬性也以扁平形式聲明。
• 開始記錄會覆蓋其他會話文件。
• 改進記錄命名 - setSessionBaseline，getDiffSinceBaseline。

⚠️ 故障排除

"LCOV 文件未找到"

• 確保你已啟用覆蓋率運行測試套件。
• 檢查你的 LCOV 文件路徑是否正確（相對路徑從當前工作目錄解析）。
• 默認路徑是 ./coverage/lcov.info。

"未找到文件的覆蓋率數據"

• 驗證文件路徑與 LCOV 文件中顯示的路徑完全匹配。
• 一些測試框架使用絕對路徑，而其他框架使用相對路徑。

"未找到基線記錄"

• 必須在調用 get_diff_since_start 之前調用 start_recording。
• 基線存儲在臨時存儲中，系統重啟時會清除。

🛠️ 開發

# 安裝依賴
npm install

# 構建
npm run build

# 運行測試（包含覆蓋率！）
npm test

# 運行代碼檢查器
npm run lint

# 使用 MCP 檢查器進行測試
npm run inspect

🤝 貢獻

歡迎貢獻！請隨時提交拉取請求。