Codeql N1ght MCP Server

🚀 CodeQL N1ght MCP 服務器

這是一個模型上下文協議（MCP）服務器，用於將 CodeQL N1ght 工具與 AI 助手集成，為 AI 助手提供與 CodeQL N1ght 工具交互的標準化接口，實現包括環境設置、數據庫創建和安全掃描等自動化代碼分析工作流程。

🚀 快速開始

運行 MCP 服務器的步驟如下：

1. 安裝依賴：

pip install -r requirements.txt

2. 確保 CodeQL N1ght 可執行文件在配置的路徑下（默認：J:\mcp\codeql-n1ght.exe）。
3. 以標準輸入輸出（STDIO）模式運行 MCP 服務器：

python codeql_n1ght_mcp_server.py

✨ 主要特性

• 環境安裝：一鍵設置 JDK、Ant 和 CodeQL 依賴。
• 數據庫創建：可使用可配置的反編譯器從 JAR/WAR/ZIP 文件創建 CodeQL 數據庫。
• 安全掃描：使用可定製的查詢包執行安全掃描。
• 並行處理：支持協程和多線程。
• 靈活配置：可自定義路徑、超時時間和緩存選項。

📦 安裝指南

1. 安裝依賴：

pip install -r requirements.txt

2. 確保 CodeQL N1ght 可執行文件在配置的路徑下（默認：J:\mcp\codeql-n1ght.exe）。

💻 使用示例

基礎用法

運行 MCP 服務器：

python codeql_n1ght_mcp_server.py

高級用法

不同工具的使用示例如下：

• version：獲取 CodeQL N1ght 可執行文件的版本或幫助信息。
• install_environment：使用可選的自定義 URL 安裝所需依賴（JDK、Ant、CodeQL）。
• create_database：從目標文件（JAR/WAR/ZIP）創建 CodeQL 數據庫，可進行以下配置：
  • 反編譯器選擇（procyon/fernflower）
  • 依賴處理（無/全部）
  • 並行處理
  • 緩存管理
• scan_database：在 CodeQL 數據庫上執行安全掃描，可配置以下內容：
  • 數據庫和查詢包路徑
  • 並行處理選項
  • 緩存控制
• run_codeql_n1ght：使用自定義參數直接執行命令的通用接口。

📚 詳細文檔

配置

• 默認可執行文件路徑：J:\mcp\codeql-n1ght.exe
• 路徑兼容性：支持 Windows (J:\path) 和 Unix 風格 (/j:/path) 的路徑格式。
• 超時時間：每個操作都可配置（一般操作默認 10 分鐘，數據庫/掃描操作默認 20 小時）。

響應格式

所有工具都返回標準化的響應格式：

{
  "returncode": 0,
  "stdout": "command output",
  "stderr": "error output",
  "timeout": false
}

錯誤處理

• 可執行文件未找到：如果缺少 CodeQL N1ght 可執行文件，則返回錯誤。
• 參數無效：驗證反編譯器和依賴選項。
• 超時管理：可配置超時時間並終止進程。
• 路徑解析：自動進行路徑規範化和驗證。

📄 許可證

本項目是開源的，採用 MIT 許可證。