Codelogic MCP Server

🚀 codelogic-mcp-server

A MCP server that leverages Codelogic's rich software dependency data to enhance the functionality of your AI programming assistant.

🚀 Quick Start

This MCP server utilizes Codelogic's software dependency data to empower your AI programming assistant. It comes with two useful tools and can be configured in Visual Studio Code.

✨ Features

Tools

The server implements two tools:

• codelogic-method-impact: Obtain code impact assessment from the Codelogic server's API.
  • Input the "method" you are working on and its associated "class".
• codelogic-database-impact: Analyze the relationship between code and database entities.
  • Input the type of database entity (column, table, or view) you want to analyze and its name.

📦 Installation

Prerequisites

This MCP server relies on Astral UV to run. Please install Astral UV first.

{
  "servers": {
    "codelogic-mcp-server": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "codelogic-mcp-server@latest"
      ],
      "env": {
        "CODELOGIC_SERVER_HOST": "<Server URL, e.g., https://myco.app.codelogic.com>",
        "CODELOGIC_USERNAME": "<My username>",
        "CODELOGIC_PASSWORD": "<My password>",
        "CODELOGIC_MV_NAME": "<My materialized view>",
        "CODELOGIC_DEBUG_MODE": "true"
      }
    }
  }
}

Environment Variables

The following environment variables can be used to customize the server's behavior:

• CODELOGIC_SERVER_HOST: The URL of the Codelogic server.
• CODELOGIC_USERNAME: Your Codelogic username.
• CODELOGIC_PASSWORD: Your Codelogic password.
• CODELOGIC_MV_NAME: The name of the materialized view to use.
• CODELOGIC_DEBUG_MODE: Set to "true" to enable debug mode. When enabled, additional debug files such as timing_log.txt and impact_data*.json will be generated. The default value is "false".

Example Configuration

"env": {
  "CODELOGIC_SERVER_HOST": "<Server URL, e.g., https://myco.app.codelogic.com>",
  "CODELOGIC_USERNAME": "<My username>",
  "CODELOGIC_PASSWORD": "<My password>",
  "CODELOGIC_MV_NAME": "<My materialized view>",
  "CODELOGIC_DEBUG_MODE": "true"
}

Version Pinning

In addition to using the latest version of the server, you can specify a particular version by changing the args field, for example:

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

Version Compatibility

This MCP server has the following version compatibility requirements:

• Versions 0.3.1 and lower: Compatible with all Codelogic API versions.
• Versions 0.4.0 and higher: Require Codelogic API version 25.10.0 or higher.

When upgrading, ensure that your Codelogic server meets the minimum API version requirement.

💻 Usage Examples

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 do not require a connection to the Codelogic server.

Integration Tests (Optional)

If you wish to run integration tests that connect to an actual Codelogic server:

1. Copy test/.env.test.example to test/.env.test and fill in 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.