MCP Joern

🚀 Joern MCP 服務器

Joern MCP 服務器是一個基於 Joern 的簡單 MCP 服務器，能為開發人員提供代碼審查和安全分析的功能，助力開發工作高效開展。

🚀 快速開始

Joern MCP 服務器為開發人員提供了代碼審查和安全分析的功能。以下是快速使用該項目的步驟：

1. 啟動 Joern 服務器：

   joern -J-Xmx40G --server --server-host 127.0.0.1 --server-port 16162 --server-auth-username user --server-auth-password password --import server_tools.sc
   或者
   joern -J-Xmx40G --server --server-host 127.0.0.1 --server-port 16162 --server-auth-username user --server-auth-password password --import server_tools_source.sc
   

2. 將 env_example.txt 複製到 .env 文件中，並修改配置信息以匹配 Joern 服務器的啟動配置。
3. 運行連接測試：修改 test_mcp_client.py 中的信息，確認 Joern 服務器是否正常運行。

   uv run test_mcp_client.py
   Starting MCP server test...
   ==================================================
   Testing server connection...
   [04/16/25 20:38:54] INFO     Processing request of type CallToolRequest                                                                                                                     server.py:534
   Connection test result: 成功連接到 Joern MCP，Joern 服務器版本為 XXX
   

4. 配置 MCP 服務器：在控制檯中配置 MCP 服務器，請參考 sample_cline_mcp_settings.json。
5. 使用 MCP 服務器：向大型語言模型提問，請參閱 prompts_en.md。

✨ 主要特性

該項目是一個基於 Joern 的 MCP 服務器，提供提供了一系列功能輔助開發人員進行代碼審查和安全安全分析。

📦 安裝指南

環境要求

• � 運行該Jo M Jo Jo � Jo
• • Python >= 3.10（默認為 3.12）& uv

• Joern

安裝步驟

1. 本地克隆項目：

   ```bash
   git clone https://github.com/sfncat/s/s/s/s/sfncat/mcp-joern.git
   cd cd m cd cd cd > cd mcp-joern
   

2. 安裝 Python 依賴項。

⚠️ 重要提示

請確保在虛擬環境中安裝依賴，避免全局環境的汙染。

uv venv .venv
source .venv/bin/activate
uv sync

💻 使用示例

基礎用法

以下是啟動 Joern 服務器的基礎命令：

joern -J-Xmx40G --server --server-host 127.0.0.1 --server-port 16162 --server-auth-username user --server-auth-password password --import server_tools.sc

高級用法

若需要使用 server_tools_source.sc 啟動 Joern 服務器，可使用以下命令：

joern -J-Xmx40G --server --server-host 127.0.0.1 --server-port 16162 --server-auth-username user --server-auth-password password --import server_tools_source.sc

📚 詳細文檔

項目結構

├── server.py                       # MCP 服務器主程序
├── test_mcp_client.py              # 測試 Joern 服務器和 mcp 工具的測試程序
├── test_sc_tools.py                # 直接測試 sc 工具的測試程序
├── common_tools.py                 # 公共工具函數
├── server_tools.py                 # 服務器工具函數
├── server_tools.sc                 # Scala 實現的服務器工具函數
├── server_tools_source.sc          # 使用 sourceCode 獲取方法源代碼的 Scala 實現服務器工具函數
├── requirements.txt                # Python 依賴文件
├── sample_cline_mcp_settings.json  # 示例 cline mcp 配置文件
└── env_example.txt                 # 環境變量示例文件

開發注意事項

• .env 文件用於存儲環境變量。
• .gitignore 文件定義了 Git 版本控制要忽略的文件。
• pyproject.toml 定義了項目的 Python 配置。
• MCP 工具開發：在 server_tools.sc 中實現功能，在 server_tools.py 中添加定義，並在 test_mcp_client.py 中添加測試。

貢獻指南

歡迎提交 Issues 和 Pull Requests 來幫助改進項目。也歡迎添加更多工具。

參考資料

• https://github.com/flankerhqd/jebmcp
• https://docs.joern.io/server/
• https://docs.joern.io/interpreter/