GitHub - CodeLogicIncEngineering/codelogic-mcp-server: An MCP Server to utilize Codelogic's rich software dependency data in your AI programming assistant. (original) (raw)

codelogic-mcp-server

An MCP Server to utilize Codelogic's rich software dependency data in your AI programming assistant.

Components

Tools

The server implements two tools:

Install

Pre Requisites

The MCP server relies upon Astral UV to run, please install

MacOS Workaround for uvx

There is a known issue with uvx on MacOS where the CodeLogic MCP server may fail to launch in certain IDEs (such as Cursor), resulting in errors like: See issue #11

Failed to connect client closed

This appears to be a problem with Astral uvx running on MacOS. The following can be used as a workaround:

  1. Clone this project locally.
  2. Configure your mcp.json to use uv instead of uvx. For example:

{ "mcpServers": { "codelogic-mcp-server": { "type": "stdio", "command": "/uv", "args": [ "--directory", "/codelogic-mcp-server-main", "run", "codelogic-mcp-server" ], "env": { "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "", "CODELOGIC_PASSWORD": "", "CODELOGIC_WORKSPACE_NAME": "", "CODELOGIC_DEBUG_MODE": "true" } } } }

  1. Restart Cursor.
  2. Ensure the Cursor Global Rule for CodeLogic is in place.
  3. Open the MCP tab in Cursor and refresh the codelogic-mcp-server.
  4. Ask Cursor to make a code change in an existing class. The MCP server should now run the impact analysis successfully.

Configuration for Different IDEs

Visual Studio Code Configuration

To configure this MCP server in VS Code:

  1. First, ensure you have GitHub Copilot agent mode enabled in VS Code.
  2. Create a .vscode/mcp.json file in your workspace with the following configuration:

{ "servers": { "codelogic-mcp-server": { "type": "stdio", "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "", "CODELOGIC_PASSWORD": "", "CODELOGIC_WORKSPACE_NAME": "", "CODELOGIC_DEBUG_MODE": "true" } } } }

Note: On some systems, you may need to use the full path to the uvx executable instead of just "uvx". For example: /home/user/.local/bin/uvx on Linux/Mac or C:\Users\username\AppData\Local\astral\uvx.exe on Windows.

  1. Alternatively, you can run the MCP: Add Server command from the Command Palette and provide the server information.
  2. To manage your MCP servers, use the MCP: List Servers command from the Command Palette.
  3. Once configured, the server's tools will be available to Copilot agent mode. You can toggle specific tools on/off as needed by clicking the Tools button in the Chat view when in agent mode.
  4. To use the Codelogic tools in agent mode, you can specifically ask about code impacts or database relationships, and the agent will utilize the appropriate tools.

Claude Desktop Configuration

Configure Claude Desktop by editing the configuration file:

Add the following to your configuration file:

"mcpServers": { "codelogic-mcp-server": { "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "", "CODELOGIC_PASSWORD": "", "CODELOGIC_WORKSPACE_NAME": "" } } }

Note: On some systems, you may need to use the full path to the uvx executable instead of just "uvx". For example: /home/user/.local/bin/uvx on Linux/Mac or C:\Users\username\AppData\Local\astral\uvx.exe on Windows.

After adding the configuration, restart Claude Desktop to apply the changes.

Windsurf IDE Configuration

To run this MCP server with Windsurf IDE:

Configure Windsurf IDE:

To configure Windsurf IDE, you need to create or modify the ~/.codeium/windsurf/mcp_config.json configuration file.

Add the following configuration to your file:

"mcpServers": { "codelogic-mcp-server": { "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "", "CODELOGIC_PASSWORD": "", "CODELOGIC_WORKSPACE_NAME": "" } } }

Note: On some systems, you may need to use the full path to the uvx executable instead of just "uvx". For example: /home/user/.local/bin/uvx on Linux/Mac or C:\Users\username\AppData\Local\astral\uvx.exe on Windows.

After adding the configuration, restart Windsurf IDE or refresh the tools to apply the changes.

Cursor Configuration

To configure the CodeLogic MCP server in Cursor:

  1. Configure the MCP server by creating a .cursor/mcp.json file:

{ "mcpServers": { "codelogic-mcp-server": { "command": "uvx", "args": [ "codelogic-mcp-server@latest" ], "env": { "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "", "CODELOGIC_PASSWORD": "", "CODELOGIC_WORKSPACE_NAME": "", "CODELOGIC_DEBUG_MODE": "true" } } } }

Note: On some systems, you may need to use the full path to the uvx executable instead of just "uvx". For example: /home/user/.local/bin/uvx on Linux/Mac or C:\Users\username\AppData\Local\astral\uvx.exe on Windows.

  1. Restart Cursor to apply the changes.

The CodeLogic MCP server tools will now be available in your Cursor workspace.

AI Assistant Instructions/Rules

To help the AI assistant use the CodeLogic tools effectively, you can add the following instructions/rules to your client's configuration. We recommend customizing these instructions to align with your team's specific coding standards, best practices, and workflow requirements:

VS Code (GitHub Copilot) Instructions

Create a .vscode/copilot-instructions.md file with the following content:

CodeLogic MCP Server Instructions

When modifying existing code methods:

When modifying SQL code or database entities:

To use the CodeLogic tools effectively:

Claude Desktop Instructions

Create a file ~/.claude/instructions.md with the following content:

CodeLogic MCP Server Instructions

When modifying existing code methods:

When modifying SQL code or database entities:

To use the CodeLogic tools effectively:

Windsurf IDE Rules

Create or modify the ~/.codeium/windsurf/memories/global_rules.md markdown file with the following content:

When modifying existing code methods:

When modifying SQL code or database entities:

To use the CodeLogic tools effectively:

Cursor Global Rule

To configure CodeLogic rules in Cursor:

  1. Open Cursor Settings
  2. Navigate to the "Rules" section
  3. Add the following content to "User Rules":

CodeLogic MCP Server Rules

Codebase

AI Assistant Behavior

Environment Variables

The following environment variables can be configured to customize the behavior of the server:

Example Configuration

"env": { "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>", "CODELOGIC_USERNAME": "", "CODELOGIC_PASSWORD": "", "CODELOGIC_WORKSPACE_NAME": "", "CODELOGIC_DEBUG_MODE": "true" }

Pinning the version

instead of using the latest version of the server, you can pin to a specific version by changing the args field to match the version in pypi e.g.

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

Version Compatibility

This MCP server has the following version compatibility requirements:

If you're upgrading, make sure your CodeLogic server meets the minimum API version requirement.

Debug Logging

When CODELOGIC_DEBUG_MODE=true, debug files are written to the system temporary directory:

Debug files include:

Finding your log directory:

import tempfile import os print("Log directory:", os.path.join(tempfile.gettempdir(), "codelogic-mcp-server"))

Testing

Running Unit Tests

The project uses unittest for testing. You can run unit tests without any external dependencies:

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

Unit tests use mock data and don't require a connection to a CodeLogic server.

Integration Tests (Optional)

If you want to run integration tests that connect to a real CodeLogic server:

  1. Copy test/.env.test.example to test/.env.test and populate with your CodeLogic server details
  2. Run the integration tests:

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

Note: Integration tests require access to a CodeLogic server instance.

Validation for Official MCP Registry

mcp-name: io.github.CodeLogicIncEngineering/codelogic-mcp-server