![\"An](\"https://raw.githubusercontent.com/jztan/redmine-mcp-server/develop/assets/redmine-mcp-demo.gif\")
\n \n\n \n \n \n
An AI agent triaging a Redmine sprint through redmine-mcp-server. Try the live demo →
\n\n## [Tool reference](./docs/tool-reference.md) | [Changelog](./CHANGELOG.md) | [Contributing](./docs/contributing.md) | [Troubleshooting](./docs/troubleshooting.md)\n\n## Features\n\n- **45 MCP tools on a stock Redmine, 58 with the RedmineUP and DMSF plugins** (plus 1 operator tool gated by `REDMINE_MCP_EXPOSE_ADMIN_TOOLS=true`): Issues, projects, time tracking, wiki, Gantt, file operations, membership management, products, contacts and deals (CRM), DMSF documents, and more\n- **Interactive Kanban Board**: `show_triage_board` renders a live, drag-and-drop issue board right in the chat via the MCP Apps extension\n- **Flexible Authentication**: API key, username/password, or OAuth2 per-user tokens\n- **Prompt Injection Protection**: User-controlled content wrapped in boundary tags for safe LLM consumption\n- **Read-Only Mode**: Restrict to read-only operations via `REDMINE_MCP_READ_ONLY` environment variable\n- **HTTP File Serving**: Secure attachment access via UUID-based URLs with automatic expiry\n- **Pagination Support**: Handle large result sets with configurable limits\n- **MCP Compliant**: Built on FastMCP with HTTP transport\n- **Docker Ready**: Dockerfile, docker-compose setup, and prebuilt images on GHCR\n\n## Quick Start\n\n1. **Install the package**\n ```bash\n pip install redmine-mcp-server\n ```\n2. **Create a `.env` file** with your Redmine credentials (see [Installation](#installation) for template)\n3. **Start the server**\n ```bash\n redmine-mcp-server\n ```\n4. **Add the server to your MCP client** using one of the guides in [MCP Client Configuration](#mcp-client-configuration).\n\nOnce running, the server listens on `http://localhost:8000` with the MCP endpoint at `/mcp`, health check at `/health`, and file serving at `/files/{file_id}`.\n\n## Installation\n\n### Prerequisites\n\n- Python 3.10+ (for local installation)\n- Docker (alternative deployment, uses Python 3.13)\n- Access to a Redmine instance\n\n#### Redmine Compatibility\n\nThe integration suite passes in full against Redmine 6.1 and 7.0. Older\nversions are untested. Individual tools list their own minimum where one is\nknown (global search needs 3.3.0+, issue watchers 2.3.0+, project time-entry\nactivities 3.4.0+), so on an older server those specific tools fail rather than\nthe whole server.\n\nOAuth2 is the one hard requirement: it needs Redmine 6.1+ for Doorkeeper\nsupport. See [docs/oauth-setup.md](docs/oauth-setup.md).\n\n### Install from PyPI (Recommended)\n\n```bash\n# Install the package\npip install redmine-mcp-server\n\n# Create configuration file .env\ncat > .env << 'EOF'\n# Redmine connection (required)\nREDMINE_URL=https://your-redmine-server.com\n\n# Authentication - Use either API key (recommended) or username/password\nREDMINE_API_KEY=your_api_key\n# OR use username/password:\n# REDMINE_USERNAME=your_username\n# REDMINE_PASSWORD=your_password\n\n# Server configuration (optional, defaults shown)\nSERVER_HOST=0.0.0.0\nSERVER_PORT=8000\n\n# Public URL for file serving (optional)\nPUBLIC_HOST=localhost\nPUBLIC_PORT=8000\n\n# File management (optional)\nATTACHMENTS_DIR=./attachments\nAUTO_CLEANUP_ENABLED=true\nCLEANUP_INTERVAL_MINUTES=10\nATTACHMENT_EXPIRES_MINUTES=60\nEOF\n\n# Edit .env with your actual Redmine settings\nnano .env # or use your preferred editor\n\n# Run the server\nredmine-mcp-server\n# Or alternatively:\npython -m redmine_mcp_server.main\n```\n\nThe server runs on `http://localhost:8000` with the MCP endpoint at `/mcp`, health check at `/health`, and file serving at `/files/{file_id}`.\n\n### Environment Variables Configuration\n\n