- Home
- MCP servers
- Redmine
Redmine
- typescript
70
GitHub Stars
typescript
Language
4 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"yonaka15-mcp-server-redmine": {
"command": "npx",
"args": [
"-y",
"--prefix",
"/path/to/mcp-server-redmine",
"mcp-server-redmine"
],
"env": {
"REDMINE_HOST": "https://your-redmine.example.com",
"REDMINE_API_KEY": "your-api-key-here"
}
}
}
}You can use this MCP Server to access Redmine data through a Model Context Protocol client. It exposes stable Redmine REST API resources such as issues, projects, users, and time entries to enable dynamic Q&A, summaries, and task-aware interactions with your Redmine data via large language models.
How to use
To use this MCP server with your client, start the local MCP server process and point your MCP client to it. You will run the server via a standard command, providing your Redmine host and API key as environment variables. Once running, you can query resources like issues, projects, users, and time entries and perform common actions such as listing, retrieving details, and creating or updating records where supported.
How to install
Prerequisites: you need Node.js 18 or higher and npm 9 or higher.
Install dependencies for the MCP server project, build, and start the server according to the commands shown.
Configuration and usage notes
Environment variables you will need to provide to connect to Redmine are shown in the execution example. Set the Redmine host URL and your API key to authorize API requests.
The MCP server supports the following actions for Redmine data: list issues with filters, get issue details, create or update issues, delete issues; list projects, get project details, create or update projects, archive/unarchive, delete; list and show users (admin privileges may be required); list and show time entries, create or update time entries, delete.
Testing and validation
Run unit tests to verify functionality. Use an inspector tool to verify the MCP endpoints and behavior. Build the project, ensure executable permissions on the built script, and run test commands to exercise the available tools.
# Build and start the MCP server for testing
npm install
npm run build
# Start the server in a local environment (example; adjust to your setup)
export REDMINE_API_KEY=your-api-key-here
export REDMINE_HOST=https://your-redmine.example.com
node dist/index.js
Available tools
list_issues
List issues with optional filters such as project_id, status_id, assignee, and limit. Returns matching issues.
get_issue
Retrieve detailed information for a single issue by its ID.
list_projects
List projects with optional keyword filtering and status filters.
show_project
Get detailed information about a specific project, including trackers and categories.
list_users
List users (admin privileges may be required) and fetch user details.
show_user
Get detailed information for a specific user by ID.
list_time_entries
List time entries with optional filters such as project_id, user_id, and date range.
show_time_entry
Get details for a specific time entry by ID.