使用说明
项目简介
CodeLogic MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在将 CodeLogic 强大的软件依赖数据集成到您的 AI 编程助手 (如 GitHub Copilot Agent, Claude, Windsurf IDE) 中。通过提供代码方法和数据库实体的影响分析工具,帮助开发者在修改代码前预判潜在风险,提升代码变更的安全性和效率。
主要功能点
- 代码方法影响分析 (codelogic-method-impact): 分析修改特定类中的方法可能带来的代码影响,例如依赖该方法的其他组件。
- 数据库影响分析 (codelogic-database-impact): 分析代码与数据库实体(表、列、视图)之间的依赖关系,帮助理解数据库变更对代码的影响,以及代码变更对数据库的潜在影响。
安装步骤
- 安装 Astral UV: 本服务器依赖 Astral UV 运行,请先根据 官方文档 安装 UV。
服务器配置
MCP 服务器需要配置到 MCP 客户端 (如 VS Code, Claude, Windsurf IDE) 中才能使用。以下是针对不同客户端的配置方法,您只需选择您使用的客户端进行配置即可。
Visual Studio Code 配置 (mcp.json)
在您的 VS Code 工作区目录的 '.vscode' 文件夹下创建或编辑 'mcp.json' 文件,添加以下服务器配置:
{ "servers": { "codelogic-mcp-server": { "type": "stdio", "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<您的 CodeLogic 服务器地址,例如: https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "<您的 CodeLogic 用户名>", "CODELOGIC_PASSWORD": "<您的 CodeLogic 密码>", "CODELOGIC_MV_NAME": "<您的 CodeLogic 实化视图名称>", "CODELOGIC_DEBUG_MODE": "true" // 可选,设置为 "true" 启用调试模式 } } } }
参数说明:
- 'type': 固定为 "stdio",表示使用标准输入输出流通信。
- 'command': 固定为 "uvx",表示使用 uvx 运行。
- 'args': 服务器启动参数,'"codelogic-mcp-server@latest"' 表示运行最新版本的 codelogic-mcp-server。您也可以指定版本号,例如 '"[email protected]"'。
- 'env': 环境变量配置,用于连接您的 CodeLogic 服务器。
- 'CODELOGIC_SERVER_HOST': 必需,您的 CodeLogic 服务器地址。
- 'CODELOGIC_USERNAME': 必需,您的 CodeLogic 用户名。
- 'CODELOGIC_PASSWORD': 必需,您的 CodeLogic 密码。
- 'CODELOGIC_MV_NAME': 必需,您的 CodeLogic 实化视图名称。
- 'CODELOGIC_DEBUG_MODE': 可选,设置为 '"true"' 启用调试模式,生成额外的调试日志文件。 默认为 '"false"'。
Claude Desktop 配置 (claude_desktop_config.json)
编辑 Claude Desktop 的配置文件:
- MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
- Linux: '~/.config/Claude/claude_desktop_config.json'
在配置文件中 '"mcpServers"' 字段下添加以下服务器配置:
"mcpServers": { "codelogic-mcp-server": { "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<您的 CodeLogic 服务器地址,例如: https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "<您的 CodeLogic 用户名>", "CODELOGIC_PASSWORD": "<您的 CodeLogic 密码>", "CODELOGIC_MV_NAME": "<您的 CodeLogic 实化视图名称>" } } }
参数说明: 与 VS Code 配置中的参数说明一致。
Windsurf IDE 配置 (mcp_config.json)
创建或编辑 Windsurf IDE 的配置文件 '~/.codeium/windsurf/mcp_config.json',添加以下服务器配置:
"mcpServers": { "codelogic-mcp-server": { "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<您的 CodeLogic 服务器地址,例如: https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "<您的 CodeLogic 用户名>", "CODELOGIC_PASSWORD": "<您的 CodeLogic 密码>", "CODELOGIC_MV_NAME": "<您的 CodeLogic 实化视图名称>" } } }
参数说明: 与 VS Code 配置中的参数说明一致。
基本使用方法
配置完成后,重启您的 MCP 客户端 (VS Code, Claude, Windsurf IDE)。
在客户端的 Agent 模式下,您可以:
- 针对代码方法,询问 "代码影响分析" 或 "分析方法 [方法名] 的影响"。
- 针对数据库实体,询问 "数据库影响分析" 或 "分析表 [表名] 的影响" 或 "分析列 [列名] 在表 [表名] 中的影响"。
客户端将调用 'codelogic-method-impact' 或 'codelogic-database-impact' 工具,并返回分析结果,帮助您理解代码或数据库变更的潜在影响。
示例对话 (Windsurf IDE Global Rule):
您可以在 '~/.codeium/windsurf/memories/global_rules.md' 文件中添加如下规则,以引导 Windsurf 在代码修改时自动调用 CodeLogic 工具:
When I ask you to modify existing code, try running the codelogic-method-impact and codelogic-database-impact MCP tools against the code I've provided and any methods or functions that you are changing. Make sure the results sent back from the tool are highlighted as impacts for the given method or function.
注意: 请确保您已在 CodeLogic 服务器中创建了实化视图 (Materialized View),并在配置中填写了正确的实化视图名称。
信息
分类
开发者工具