codescan-mcp-server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@codescan-mcp-server show open issues with severity MAJOR"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Codescan MCP Server
A Model Context Protocol (MCP) server implementation for Codescan, enabling AI models to interact with Codescan's API through a standardized interface.
Features
List Codescan projects
Get project metrics
Query project issues with advanced filtering
Environment-based configuration
Docker support
TypeScript implementation
Related MCP server: sonarqube-mcp-py
Prerequisites
Node.js 20 or later
pnpm 10.7.1 or later
Docker (optional, for containerized deployment)
Installation
Local Development
Clone the repository:
git clone <repository-url>
cd codescan-mcp-serverInstall dependencies:
pnpm installBuild the project:
pnpm run buildStart the server:
pnpm startDocker Deployment
Build the Docker image:
docker build -t codescan-mcp-server .Run the container:
docker run -d \
-e CODESCAN_URL=https://app.codescan.io \
-e CODESCAN_TOKEN=your_token_here \
-e CODESCAN_ORGANIZATION=your_org \
-e CODESCAN_PROJECT=your_project \
-e CODESCAN_COMPONENT=your_component \
-e NODE_OPTIONS="--experimental-specifier-resolution=node" \
-p 3000:3000 \
codescan-mcp-serverEnvironment Variables
Variable | Description | Required | Default |
CODESCAN_URL | URL of your Codescan instance | Yes | |
CODESCAN_TOKEN | Authentication token for Codescan API | Yes | - |
CODESCAN_ORGANIZATION | Organization key for Codescan Cloud | No | - |
CODESCAN_PROJECT | Default project key | No | - |
CODESCAN_COMPONENT | Default component key | No | - |
NODE_OPTIONS | Node.js runtime options | No | --experimental-specifier-resolution=node |
MCP Client Configuration
Here's an example MCP client configuration for interacting with the Codescan MCP server:
{
"name": "codescan-mcp-client",
"version": "1.0.0",
"description": "MCP client for Codescan integration",
"servers": [
{
"name": "codescan-mcp-server",
"url": "http://localhost:3000",
"tools": ["projects", "metrics", "issues"]
}
],
"env": {
"CODESCAN_URL": "https://app.codescan.io",
"CODESCAN_TOKEN": "your_token_here",
"CODESCAN_ORGANIZATION": "your_org",
"CODESCAN_PROJECT": "your_project",
"CODESCAN_COMPONENT": "your_component"
}
}Tool Usage Examples
List Projects:
{
"tool": "projects",
"params": {
"page": "1",
"page_size": "10"
}
}Get Metrics:
{
"tool": "metrics",
"params": {
"component": "your_component",
"page": "1",
"page_size": "10"
}
}Get Issues:
{
"tool": "issues",
"params": {
"component": "your_component",
"severity": "MAJOR",
"page": "1",
"page_size": "10",
"statuses": ["OPEN", "CONFIRMED"],
"types": ["BUG", "VULNERABILITY"]
}
}Development
Available Scripts
pnpm run build: Build the TypeScript codepnpm start: Start the MCP serverpnpm test: Run testspnpm lint: Run linterpnpm format: Format code
Project Structure
codescan-mcp-server/
├── src/
│ ├── index.ts # Main server entry point
│ └── codescan.ts # Codescan API client
├── dist/ # Compiled JavaScript
├── Dockerfile # Docker configuration
├── package.json # Project dependencies
├── tsconfig.json # TypeScript configuration
└── mcp.json # MCP server configurationLicense
[License Type] - See LICENSE file for details
Available Tools
3 toolsTool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 3 tools
Each tool has a distinct purpose: listing projects, retrieving issues for a project, and fetching metrics. There is no overlap or ambiguity.
All tool names are single nouns, which is consistent. Adding verbs (e.g., list_projects) would make them more descriptive, but the pattern is uniform.
3 tools is a reasonable number for a focused code scanning server. It covers the core actions without being overly sparse.
The server covers listing projects, retrieving issues, and getting metrics. Missing are details on individual projects, issue filtering, or update/delete operations, but for a read-only scanner it is fairly complete.
Maintenance
Related MCP Connectors
MCP server for AI access to Swagger by SmartBear.
MCP server that lets AI assistants use all OneSchema features exposed via the public API.
MCP server providing access to the Scorecard API to evaluate and optimize LLM systems.
MCP server for secureFlows: token-free URL builders and integration-linting tools for AI agents.
Related MCP Servers
- AlicenseAqualityCmaintenanceAn MCP server for SonarQube that enables LLM agents to discover projects, analyze code quality metrics, check Quality Gate status, search issues with filters, and rank projects by worst-performing metrics. It provides read-only, safe access to SonarQube instances with structured outputs and error handling.51MIT
- AlicenseCqualityDmaintenanceA Python MCP server for SonarQube, enabling AI agents to query projects, issues, quality gates, coverage, and security hotspots.13MIT
- AlicenseNot gradedqualityDmaintenanceMCP server for ai-scanner that enables AI agents to scan codebases for LLM usage, AI frameworks, and exposed secrets.1MIT
- FlicenseNot gradedqualityCmaintenanceMCP server that exposes SonarQube data as AI agent tools, enabling project discovery, quality gates, measures, issues, hotspots, rule explanations, source code, and raw API access.4-