-
Notifications
You must be signed in to change notification settings - Fork 28
Improve README setup guidance #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -21,6 +21,21 @@ A Model Context Protocol (MCP) server that integrates with Redmine project manag | |||||
| - **Docker Ready**: Complete containerization support | ||||||
| - **Comprehensive Testing**: Unit, integration, and connection tests | ||||||
|
|
||||||
| ## Quick Start | ||||||
|
|
||||||
| 1. **Install the package** | ||||||
| ```bash | ||||||
| pip install redmine-mcp-server | ||||||
| ``` | ||||||
| 2. **Create a `.env` file** using the template below and fill in your Redmine credentials. | ||||||
| 3. **Start the server** | ||||||
| ```bash | ||||||
| redmine-mcp-server | ||||||
| ``` | ||||||
| 4. **Add the server to your MCP client** using one of the guides in [MCP Client Configuration](#mcp-client-configuration). | ||||||
|
|
||||||
| Once 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}`. | ||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| ### Prerequisites | ||||||
|
|
@@ -101,12 +116,22 @@ uv run python -m redmine_mcp_server.main | |||||
|
|
||||||
| The server runs on `http://localhost:8000` with the MCP endpoint at `/mcp`, health check at `/health`, and file serving at `/files/{file_id}`. | ||||||
|
|
||||||
| ### File Management Configuration | ||||||
|
|
||||||
| - **`ATTACHMENTS_DIR`**: Directory where downloaded attachments are stored (default: `./attachments`) | ||||||
| - **`AUTO_CLEANUP_ENABLED`**: Enable automatic cleanup of expired files (default: `true`) | ||||||
| - **`CLEANUP_INTERVAL_MINUTES`**: How often cleanup runs to check for expired files (default: `10` minutes) | ||||||
| - **`ATTACHMENT_EXPIRES_MINUTES`**: Default expiry time for downloaded attachments (default: `60` minutes) | ||||||
| ### Environment Variables | ||||||
|
|
||||||
| | Variable | Required | Default | Description | | ||||||
| |----------|----------|---------|-------------| | ||||||
| | `REDMINE_URL` | ✅ | – | Base URL of your Redmine instance | | ||||||
| | `REDMINE_API_KEY` | ✅* | – | API key for authentication (*or provide username/password*) | | ||||||
| | `REDMINE_USERNAME` | ✅* | – | Username for basic auth (*use with password when not using API key*) | | ||||||
| | `REDMINE_PASSWORD` | ✅* | – | Password for basic auth | | ||||||
| | `SERVER_HOST` | ❌ | `0.0.0.0` | Host/IP the MCP server binds to | | ||||||
| | `SERVER_PORT` | ❌ | `8000` | Port the MCP server listens on | | ||||||
| | `PUBLIC_HOST` | ❌ | `localhost` | Hostname used when generating download URLs | | ||||||
| | `PUBLIC_PORT` | ❌ | `8000` | Public port used for download URLs | | ||||||
| | `ATTACHMENTS_DIR` | ❌ | `./attachments` | Directory for downloaded attachments | | ||||||
| | `AUTO_CLEANUP_ENABLED` | ❌ | `true` | Toggle automatic cleanup of expired attachments | | ||||||
| | `CLEANUP_INTERVAL_MINUTES` | ❌ | `10` | Interval for cleanup task | | ||||||
| | `ATTACHMENT_EXPIRES_MINUTES` | ❌ | `60` | Expiry window for generated download URLs | | ||||||
|
|
||||||
| **Example configurations:** | ||||||
| ```bash | ||||||
|
|
@@ -137,6 +162,24 @@ The same command is used for both development and production. Configure environm | |||||
|
|
||||||
| ### MCP Client Configuration | ||||||
|
|
||||||
| The server exposes an HTTP endpoint at `http://127.0.0.1:8000/mcp`. Register it with your preferred MCP-compatible agent using the instructions below. | ||||||
|
|
||||||
| #### Visual Studio Code (Continue / MCP Extension) | ||||||
|
|
||||||
| 1. Install the [Continue](https://continue.dev/) extension (or any MCP-compatible extension). | ||||||
| 2. Open **Settings** → search for `Continue: MCP Servers` and click **Edit in settings.json**. | ||||||
| 3. Add an entry similar to the example below: | ||||||
| ```json | ||||||
| { | ||||||
| "continue.mcpServers": { | ||||||
| "redmine": { | ||||||
| "url": "http://127.0.0.1:8000/mcp" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
| 4. Reload VS Code. The Redmine tools will appear in the MCP/Continue panel. | ||||||
|
|
||||||
| #### Claude Code | ||||||
|
|
||||||
| Add to Claude Code using the CLI command: | ||||||
|
|
@@ -145,22 +188,42 @@ Add to Claude Code using the CLI command: | |||||
| claude mcp add --transport http redmine http://127.0.0.1:8000/mcp | ||||||
| ``` | ||||||
|
|
||||||
| Or configure manually in your Claude Code (~/.claude.json): | ||||||
| Or configure manually in your Claude Code settings file (`~/.claude.json`): | ||||||
|
|
||||||
| ```json | ||||||
| { | ||||||
| "mcpServers": { | ||||||
| "my-local-server": { | ||||||
| "redmine": { | ||||||
| "type": "http", | ||||||
| "url": "http://127.0.0.1:8000/mcp" | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| #### Other MCP Clients | ||||||
| #### Codex CLI | ||||||
|
|
||||||
| The [Codex MCP CLI](https://github.com/modelcontextprotocol/cli) can connect directly to the server: | ||||||
|
||||||
| The [Codex MCP CLI](https://github.com/modelcontextprotocol/cli) can connect directly to the server: | |
| The [MCP CLI](https://github.com/modelcontextprotocol/cli) can connect directly to the server: |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.