An open API service indexing awesome lists of open source software.

https://github.com/codescene-oss/codescene-mcp-server

The CodeScene MCP Server exposes CodeScene’s Code Health analysis as local AI-friendly tools.
https://github.com/codescene-oss/codescene-mcp-server

Last synced: about 1 month ago
JSON representation

The CodeScene MCP Server exposes CodeScene’s Code Health analysis as local AI-friendly tools.

Awesome Lists containing this project

README

          

# CodeScene MCP Server

[![CodeScene Hotspot Code Health](https://codescene.io/projects/72556/status-badges/hotspot-code-health)](https://codescene.io/projects/72556)
[![CodeScene Average Code Health](https://codescene.io/projects/72556/status-badges/average-code-health)](https://codescene.io/projects/72556)
[![CodeScene System Mastery](https://codescene.io/projects/72556/status-badges/system-mastery)](https://codescene.io/projects/72556)

The **CodeScene MCP Server** exposes CodeScene's [Code Health](https://codescene.com/product/code-health) analysis as local AI-friendly tools.

This server is designed to run in your local environment and lets AI assistants (like GitHub Copilot, Cursor, Claude code, etc.) request meaningful Code Health insights directly from your codebase.
The Code Health insights augment the AI prompts with rich content around code quality issues, maintainability problems, and technical debt in general.

The repository also includes a downloadable set of public agent skills in [skills/](skills) for teams that want to reuse CodeScene MCP workflows in their own agentic pipelines.

## Getting Started with CodeScene MCP

Want AI to perform the setup? Start with [skills/installing-and-activating-codescene-mcp/SKILL.md](skills/installing-and-activating-codescene-mcp/SKILL.md).

1. Get an Access Token for the MCP Server — see [Getting a Personal Access Token](docs/getting-a-personal-access-token.md).
2. Install the MCP Server using one of the [installation options](#installation) below.
3. Add the MCP Server to your AI assistant. See the detailed instructions for your environment in the installation guide.
4. Copy the agent guidance that matches your license into your repository: [AGENTS-full.md](docs/AGENTS-full.md) for CodeScene Core users, [AGENTS-standalone.md](docs/AGENTS-standalone.md) for standalone license users, or [.amazonq/rules](.amazonq/rules) for Amazon Q. Also copy any relevant public [skills](skills) for reusable workflow prompts.

## Installation

Choose the installation method that works best for your platform.

NPM / npx (macOS, Linux, Windows)

Run the MCP server directly with npx (no install needed):

```bash
npx @codescene/codehealth-mcp
```

Or install globally:

```bash
npm install -g @codescene/codehealth-mcp
```

The first run automatically downloads the correct platform-specific binary for your system and caches it for future use. Requires [Node.js](https://nodejs.org/) 18 or later.

📖 **[Full installation & integration guide](docs/npm-installation.md)**

Claude Desktop

Download the MCP bundle from the [latest release page](https://github.com/codescene-oss/codescene-mcp-server/releases/latest):

- `codehealth-mcp-{version}.mcpb`

Then open the `.mcpb` file with Claude Desktop to install the MCP server.

Homebrew (macOS / Linux)

```bash
brew tap codescene-oss/codescene-mcp-server https://github.com/codescene-oss/codescene-mcp-server
brew install cs-mcp
```

📖 **[Full installation & integration guide](docs/homebrew-installation.md)**

Windows

Run this in PowerShell:

```powershell
irm https://raw.githubusercontent.com/codescene-oss/codescene-mcp-server/main/install.ps1 | iex
```

📖 **[Full installation & integration guide](docs/windows-installation.md)**

Manual Download

Download the latest binary for your platform from the [GitHub Releases page](https://github.com/codescene-oss/codescene-mcp-server/releases):

- **macOS:** `cs-mcp-macos-aarch64.zip` (Apple Silicon) or `cs-mcp-macos-amd64` (Intel)
- **Linux:** `cs-mcp-linux-aarch64.zip` or `cs-mcp-linux-amd64`
- **Windows:** `cs-mcp-windows-amd64.exe`

After downloading, make it executable and optionally add it to your PATH:

```bash
chmod +x cs-mcp-*
mv cs-mcp-* /usr/local/bin/cs-mcp
```

You can also [build a static executable from source](docs/building-executable-locally.md).

Docker

```bash
docker pull codescene/codescene-mcp
```

📖 **[Full installation & integration guide](docs/docker-installation.md)** | [Build the Docker image locally](docs/building-docker-locally.md)

---

## Use Cases

> [!TIP]
> Watch the [demo video of the CodeScene MCP](https://www.youtube.com/watch?v=AycLVxKmVSY).

> [!NOTE]
> CodeScene MCP comes with a set of [example prompts](.github/prompts), agent guidance files to capture the key use cases, and a downloadable set of public [skills](skills). Copy the agent guidance that matches your license — [AGENTS-full.md](docs/AGENTS-full.md) for CodeScene Core users or [AGENTS-standalone.md](docs/AGENTS-standalone.md) for standalone users — and any relevant skills to your own repository.

With the CodeScene MCP Server in place, your AI tools can:

### Safeguard AI-Generated Code
Prevent AI from introducing technical debt by flagging maintainability issues like complexity, deep nesting, low cohesion, etc.

### Uplift Unhealthy Code for AI Readiness
AI refactoring quality improves when code is modular and easy to reason about. The MCP server gives your assistant concrete guidance to get there:

- run focused Code Health reviews,
- identify the specific design issues to address,
- refactor in small, measurable steps, and
- verify progress with updated Code Health scores.

This workflow works with MCP alone and is often enough to safely improve legacy code.

If you also use [CodeScene ACE](https://codescene.com/product/integrations/ide-extensions/ai-refactoring), it can accelerate the first restructuring step for some large functions. ACE is optional and requires a separate add-on license. For details, see [ACE refactoring with MCP](docs/ace-refactoring-with-mcp.md).

### Make Targeted Refactoring
AI tools can refactor code, but they lack direction on *what* to fix and *how to measure* if it helped.
The Code Health tools solve this by giving AI assistants precise insight into design problems, as well as an objective way to assess the outcome: **did the Code Health improve?**

### Understand Existing Code Before Acting
Use Code Health reviews to inform AI-driven summaries, diagnostics, or code transformations based on **real-world cognitive and design challenges**, not just syntax.

## Frequently Asked Questions

Do I need a CodeScene account to use the MCP?

The full feature set — including hotspots, technical debt goals, and code ownership — requires a [CodeScene subscription](https://codescene.com/pricing). Use your CodeScene instance to create the `CS_ACCESS_TOKEN` which activates the MCP.
The MCP supports both CodeScene Cloud and CodeScene on-prem.

For local Code Health analysis without a CodeScene subscription, you can use the standalone [CodeScene Code Health MCP](https://codescene.com/early-access-codescene-mcp-server).

How does the MCP Server keep my code private and secure?

The CodeScene MCP Server runs fully locally. All analysis — including Code Health scoring, delta reviews, and business-case calculations — is performed on your machine, against your local repository.
No source code or analysis data is sent to cloud providers, LLM vendors, or any external service.

Analysis results (e.g. hotspots and technical debt goals) are fetched via REST from your own CodeScene account using a secure token.

For complete details, please see CodeScene's full [privacy and security documentation](https://codescene.com/policies).

Can I use any LLM as the backbone for CodeScene MCP?

CodeScene MCP can work with any model your AI assistant supports, but we strongly recommend choosing a frontier model when your assistant offers a model selector (as in tools like GitHub Copilot).

Frontier models -- such as Claude Sonnet -- deliver far better rule adherence and refactoring quality, while legacy models like GPT-4.1 often struggle with MCP constraints.
For a consistent, high-quality experience, select the newest available model.

I have multiple repos — how do I configure the MCP?

Since you have to provide a mount path for Docker, you can either have a MCP configuration per project (in VS Code that would be a `.vscode/mcp.json` file per project, for example) or you can mount a root directory within which all your projects are and then just use that one configuration instead.

Why does IntelliJ give a wrong path to the MCP server?

In our testing we've seen that IntelliJ's AI Assistant sometimes gives a wrong path to the CodeScene MCP server.
From what we can tell, it seems to have nothing to do with the MCP server itself, but rather with IntelliJ's AI Assistant, which
seems to hallucinate parts of the path some of the time. We're still investigating this issue and will update this section once we have more information.

How do I configure custom SSL certificates?

If your organization uses an internal CA (Certificate Authority), set the `REQUESTS_CA_BUNDLE` environment variable to point to your CA certificate file (PEM format). The MCP server automatically configures SSL — you only need to set it once.

The MCP also supports `SSL_CERT_FILE` and `CURL_CA_BUNDLE` as alternatives.

For detailed configuration examples (including Docker certificate mounting), see [Configuration Options — SSL/TLS](docs/configuration-options.md#ca_bundle).

How do I disable the version update check?

The MCP server periodically checks GitHub for newer releases and shows a "VERSION UPDATE AVAILABLE" banner when your version is outdated. This check runs in the background and never blocks tool responses, but in network-restricted environments you may want to disable it entirely.

Set the `CS_DISABLE_VERSION_CHECK` environment variable to any non-empty value (e.g. `1`). For setup details, see [Configuration Options — Version Check](docs/configuration-options.md#disable_version_check).

## Building from Source

The MCP server is written in Rust. To build from source:

```bash
cargo build --release
```

The binary is produced at `target/release/cs-mcp`.

For more details, see:

- [Building a static executable locally](docs/building-executable-locally.md)
- [Building a static Linux executable with musl](docs/building-linux-executable-with-docker.md)
- [Building the Docker image locally](docs/building-docker-locally.md)