Codelogic MCP Server

🚀 codelogic-mcp-server

一個利用Codelogic豐富的軟件依賴數據的MCP服務器，能增強你的AI編程助手的功能，為編程工作提供更強大的支持。

🚀 快速開始

本MCP服務器藉助Codelogic的軟件依賴數據，可有效增強AI編程助手的能力。使用前需完成相應的安裝和配置。

✨ 主要特性

工具

該服務器實現了兩個實用工具：

• codelogic-method-impact：從Codelogic服務器的API中獲取代碼的影響評估。你只需輸入正在處理的“方法”及其關聯的“類”即可。
• codelogic-database-impact：分析代碼與數據庫實體之間的關係。你需要輸入要分析的數據庫實體類型（列、表或視圖）及其名稱。

📦 安裝指南

先決條件

該MCP服務器依賴於Astral UV運行，請先安裝Astral UV。

Visual Studio Code配置

在VS Code中配置此MCP服務器的步驟如下：

1. 首先，確保你已在VS Code中啟用了GitHub Copilot的代理模式。
2. 在你的工作區創建一個.vscode/mcp.json文件，並添加以下配置：

{
  "servers": {
    "codelogic-mcp-server": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "codelogic-mcp-server@latest"
      ],
      "env": {
        "CODELOGIC_SERVER_HOST": "<服務器URL，例如https://myco.app.codelogic.com>",
        "CODELOGIC_USERNAME": "<我的用戶名>",
        "CODELOGIC_PASSWORD": "<我的密碼>",
        "CODELOGIC_MV_NAME": "<我的材料化視圖>",
        "CODELOGIC_DEBUG_MODE": "true"
      }
    }
  }
}

3. 雙擊文件以打開它，然後按Enter接受默認值。

環境變量

以下環境變量可用於自定義服務器的行為：

• CODELOGIC_SERVER_HOST：Codelogic服務器的URL。
• CODELOGIC_USERNAME：你的Codelogic用戶名。
• CODELOGIC_PASSWORD：你的Codelogic密碼。
• CODELOGIC_MV_NAME：要使用的材料化視圖名稱。
• CODELOGIC_DEBUG_MODE：設為“true”以啟用調試模式。啟用後，將生成額外的調試文件，如timing_log.txt和impact_data*.json。默認值為“false”。

示例配置

"env": {
  "CODELOGIC_SERVER_HOST": "<服務器URL，例如https://myco.app.codelogic.com>",
  "CODELOGIC_USERNAME": "<我的用戶名>",
  "CODELOGIC_PASSWORD": "<我的密碼>",
  "CODELOGIC_MV_NAME": "<我的材料化視圖>",
  "CODELOGIC_DEBUG_MODE": "true"
}

版本固定

除了使用最新版本的服務器外，你還可以通過更改args字段來指定特定版本，例如：

    "args": [
      "codelogic-mcp-server@0.2.2"
    ],

版本兼容性

此MCP服務器具有以下版本兼容性要求：

• 0.3.1及更低版本：與所有Codelogic API版本兼容
• 0.4.0及以上版本：需要Codelogic API版本25.10.0或更高版本

升級時，請確保你的Codelogic服務器滿足最低API版本要求。

💻 使用示例

基礎用法

本項目提供了測試相關的使用示例。

運行單元測試

該項目使用unittest進行測試，你可以無需任何外部依賴即可運行單元測試：

python -m unittest discover -s test -p "unit_*.py"

單元測試使用模擬數據，不需要連接到Codelogic服務器。

高級用法

集成測試（可選）

如果你希望運行連接到實際Codelogic服務器的集成測試：

1. 複製test/.env.test.example到test/.env.test並填寫你的Codelogic服務器詳細信息。
2. 運行集成測試：

python -m unittest discover -s test -p "integration_*.py"

注意：集成測試需要訪問Codelogic服務器實例。