https://github.com/runekaagaard/mcp-redmine
A redmine MCP server covering close to 100% of redmines API
https://github.com/runekaagaard/mcp-redmine
Last synced: 4 months ago
JSON representation
A redmine MCP server covering close to 100% of redmines API
- Host: GitHub
- URL: https://github.com/runekaagaard/mcp-redmine
- Owner: runekaagaard
- License: mpl-2.0
- Created: 2025-02-27T10:59:56.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-27T15:12:18.000Z (4 months ago)
- Last Synced: 2025-02-27T17:19:06.234Z (4 months ago)
- Language: Python
- Homepage:
- Size: 213 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- mcp-index - Redmine Assistant - Connects Claude to a Redmine instance for project and issue management, enabling browsing of projects, creating and updating issues, handling file attachments, tracking time entries, and updating issue statuses through the Redmine API. (APIs and HTTP Requests)
README
# MCP Redmine
**Status: Works great, but still in beta**
Let Claude be your Redmine assistant! MCP Redmine connects Claude Desktop to your Redmine instance, allowing it to:
- Search and browse projects and issues
- Create and update issues with full markdown support
- Upload and download file attachments
- Manage and track time entries
- Update issue statuses and fields
- Access comprehensive Redmine API functionality
Uses httpx for API requests and integrates with the Redmine OpenAPI specification for comprehensive API coverage.
## Requirements
- Access to a Redmine instance
- Redmine API key
- Python 3.10+
The openapi specification used is for redmine 5.0, tested on Redmine 6.0.3, but will likely work with older versions as well.
## API
### Tools
- **redmine_paths_list**
- Return a list of available API paths from OpenAPI spec
- No input required
- Returns a YAML string containing a list of path templates:
```
- /issues.json
- /projects.json
- /time_entries.json
...
```
- **redmine_paths_info**
- Get full path information for given path templates
- Input: `path_templates` (list of strings)
- Returns YAML string containing API specifications for the requested paths:
```yaml
/issues.json:
get:
operationId: getIssues
parameters:
- $ref: '#/components/parameters/format'
...
```
- **redmine_request**
- Make a request to the Redmine API
- Inputs:
- `path` (string): API endpoint path (e.g. '/issues.json')
- `method` (string, optional): HTTP method to use (default: 'get')
- `data` (object, optional): Dictionary for request body (for POST/PUT)
- `params` (object, optional): Dictionary for query parameters
- Returns YAML string containing response status code, body and error message:
```yaml
status_code: 200
body:
issues:
- id: 1
subject: "Fix login page"
...
error: ""
```
- **redmine_upload**
- Upload a file to Redmine and get a token for attachment
- Inputs:
- `file_path` (string): Fully qualified path to the file to upload
- `description` (string, optional): Optional description for the file
- Returns YAML string with the same format as redmine_request, including upload token:
```yaml
status_code: 201
body:
upload:
id: 7
token: "7.ed32257a2ab0f7526c0d72c32994c58b131bb2c0775f7aa84aae01ea8397ea54"
error: ""
```
- **redmine_download**
- Download an attachment from Redmine and save it to a local file
- Inputs:
- `attachment_id` (integer): The ID of the attachment to download
- `save_path` (string): Fully qualified path where the file should be saved
- `filename` (string, optional): Optional filename to use (determined automatically if not provided)
- Returns YAML string with download results:
```yaml
status_code: 200
body:
saved_to: "/path/to/downloaded/file.pdf"
filename: "file.pdf"
error: ""
```
## Usage with Claude Desktop
Add to your `claude_desktop_config.json`:
```json
{
"mcpServers": {
"redmine": {
"command": "uv",
"args": ["--directory", "/path/to/mcp-redmine", "run", "server.py"],
"env": {
"REDMINE_URL": "https://your-redmine-instance.example.com",
"REDMINE_API_KEY": "your-api-key"
}
}
}
}
```
Environment Variables:
- `REDMINE_URL`: URL of your Redmine instance (required)
- `REDMINE_API_KEY`: Your Redmine API key (required, see below for how to get it)
## Getting Your Redmine API Key
1. Log in to your Redmine instance
2. Go to "My account" (typically found in the top-right menu)
3. On the right side of the page, you should see "API access key"
4. Click "Show" to view your existing key or "Generate" to create a new one
5. Copy this key for use in your configuration
## Installation
1. Clone repository:
```bash
git clone https://github.com/runekaagaard/mcp-redmine.git
```
2. Ensure you have uv
```bash
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
```
3. Add Redmine configuration to claude_desktop_config.json (see above)
## Examples
### Creating a new issue
```
Let's create a new bug report in the "Website" project:
1. Title: "Homepage not loading on mobile devices"
2. Description: "When accessing the homepage from iOS or Android devices, the loading spinner appears but the content never loads. This issue started after the last deployment."
3. Priority: High
4. Assign to: John Smith
```
### Searching for issues
```
Can you find all high priority issues in the "Website" project that are currently unassigned?
```
### Updating issue status
```
Please mark issue #123 as "In Progress" and add a comment: "I've started working on this issue. Expect it to be completed by Friday."
```
### Logging time
```
Log 3.5 hours against issue #456 for "Implementing user authentication" done today.
```
## Contributing
Contributions are warmly welcomed! Whether it's bug reports, feature requests, documentation improvements, or code contributions - all input is valuable. Feel free to:
- Open an issue to report bugs or suggest features
- Submit pull requests with improvements
- Enhance documentation or share your usage examples
- Ask questions and share your experiences
The goal is to make Redmine project management with Claude even better, and your insights and contributions help achieve that.
## Acknowledgments
This project builds on the excellent work of others:
- [httpx](https://www.python-httpx.org/) - For handling HTTP requests
- [Redmine OpenAPI Specification](https://github.com/d-yoshi/redmine-openapi) - For the comprehensive API specification
- [Redmine](https://www.redmine.org/) - The flexible project management web application
## License
Mozilla Public License Version 2.0