Redmine MCP Server

Q: Which integrations are available for this server?

Allows interaction with Redmine instances to manage issues, projects, and users, providing tools to create, list, and update issues, as well as retrieve project and user information.

Q: How do I use Redmine MCP Server?

1. Click on "Install Server". 2. Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state. 3. In the chat, type @ followed by the MCP server name and your instructions, e.g., "@Redmine MCP Server list all open issues in the 'Website' project" 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.

CodeQL

A Model Context Protocol (MCP) server for Redmine integration, built with TypeScript following TDD methodology. This server allows AI assistants to interact with Redmine instances to manage issues, projects, and users with comprehensive security and monitoring features.

Features

Issue Management: Create, read, update, and list issues
Project Management: List and view project details
User Management: List and view user information
Error Handling: Comprehensive error handling with meaningful error messages
Type Safety: Full TypeScript implementation with proper type definitions

Installation

npm install npm run build

Configuration

The server requires two environment variables:

REDMINE_BASE_URL: The base URL of your Redmine instance (e.g., https://redmine.example.com)
REDMINE_API_KEY: Your Redmine API key (found in your account settings)

Usage

Running the Server

export REDMINE_BASE_URL="https://your-redmine-instance.com" export REDMINE_API_KEY="your-api-key-here" npm run dev

Building and Running

npm run build export REDMINE_BASE_URL="https://your-redmine-instance.com" export REDMINE_API_KEY="your-api-key-here" npm start

Production Deployment

# Build the project npm run build # Set production environment variables export REDMINE_BASE_URL="https://your-redmine-instance.com" export REDMINE_API_KEY="your-api-key-here" export LOG_LEVEL="info" # Start the server npm start

Available Tools

Issue Tools

list-issues: List issues with optional filtering
- Parameters: project_id, status_id, assigned_to_id, limit, offset
create-issue: Create a new issue
- Required: project_id, subject
- Optional: description, tracker_id, status_id, priority_id, assigned_to_id
get-issue: Get details of a specific issue
- Required: id
update-issue: Update an existing issue
- Required: id
- Optional: subject, description, status_id, priority_id, assigned_to_id, done_ratio

Project Tools

list-projects: List all projects
get-project: Get details of a specific project
- Required: id (can be numeric ID or string identifier)

Development

Running Tests

npm test

Running Tests with Coverage

npm run test:coverage

Running in Watch Mode

npm run test:watch

Linting

npm run lint

Type Checking

npm run typecheck

Clean Build Directory

npm run clean

API Reference

RedmineClient

The core client for interacting with Redmine's REST API.

const client = new RedmineClient({ baseUrl: 'https://redmine.example.com', apiKey: 'your-api-key' });