Improve README setup guidance - #36
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the README documentation by adding a quick start guide and expanding client setup instructions to help users get the Redmine MCP server running more easily.
- Added a Quick Start section with step-by-step installation and setup instructions
- Reorganized environment variables into a comprehensive reference table format
- Expanded MCP client configuration with detailed instructions for VS Code, Claude Code, Codex CLI, Kiro, and generic clients
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| #### Other MCP Clients | ||
| #### Codex CLI | ||
|
|
||
| The [Codex MCP CLI](https://github.com/modelcontextprotocol/cli) can connect directly to the server: |
There was a problem hiding this comment.
The link text 'Codex MCP CLI' doesn't match the actual repository name. The linked repository is for the general MCP CLI, not specifically 'Codex MCP CLI'.
Suggested change
| 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: |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Testing
https://chatgpt.com/codex/tasks/task_e_68e6505a41a4832bb90c796ae329b605