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服务器实例。