docs(mcp): improve MCP setup for beginners across all AI tools#57
Merged
docs(mcp): improve MCP setup for beginners across all AI tools#57
Conversation
- Rewrote mcp_server/README.md with step-by-step guides for Claude Code, Claude Desktop, Cursor, VS Code Copilot, Windsurf, and Zed - Added tools table entry for generate_unittest_config (was missing) - Added troubleshooting section for common setup failures - Fixed setup_devops_os_mcp.sh: replaced hardcoded ~/gsdev path with configurable INSTALL_DIR (default ~/devops_os), added --local flag for users already inside a clone, added --help and Python version check - Added .mcp.json (Claude Code project-level config) - Added .cursor/mcp.json (Cursor IDE project-level config) - Added .vscode/mcp.json (VS Code Copilot project-level config) - Updated .gitignore to track IDE MCP configs while ignoring personal settings - Removed "WIP" label from MCP section in main README.md, added curl one-liner Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the repository’s MCP (Model Context Protocol) onboarding experience by adding beginner-focused setup documentation for multiple MCP-capable AI tools and providing shareable, repo-committed MCP configuration files plus a one-command setup script for Claude Code CLI.
Changes:
- Rewrites
mcp_server/README.mdwith step-by-step setup guides for multiple MCP clients/editors and adds troubleshooting. - Adds
mcp_server/setup_devops_os_mcp.shto automate clone/venv/deps + Claude Code MCP registration. - Commits project-level MCP configs for Claude Code/Cursor/VS Code and updates
.gitignoreto track those files.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces MCP “WIP” section with a one-liner setup and links to the expanded MCP guide. |
| mcp_server/setup_devops_os_mcp.sh | New automation script for install + venv + dependency install + Claude Code MCP registration. |
| mcp_server/README.md | Major rewrite: multi-tool setup instructions, tool list, examples, and troubleshooting. |
| .vscode/mcp.json | Adds workspace MCP server config for VS Code Copilot. |
| .mcp.json | Adds repo-level MCP config for Claude Code. |
| .gitignore | Adjusts ignores to keep shareable MCP configs while ignoring other IDE settings. |
| .cursor/mcp.json | Adds project MCP config for Cursor. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
218
to
220
| ```bash | ||
| pip install -r mcp_server/requirements.txt | ||
| python mcp_server/server.py | ||
| curl -fsSL https://raw.githubusercontent.com/cloudengine-labs/devops_os/main/mcp_server/setup_devops_os_mcp.sh | bash | ||
| ``` |
There was a problem hiding this comment.
This section recommends curl ... | bash, which executes remote code without an opportunity to review it. For safer defaults, consider documenting a download-then-run flow (and/or adding a brief note telling users to inspect the script before executing), especially since this is in the project’s main README.
…est (#58) * Add MCP test automation: wire-protocol tests and setup script smoke test Agent-Logs-Url: https://github.com/cloudengine-labs/devops_os/sessions/bcbbfe9c-443e-4778-b9fa-0d9a5d00fc75 Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com> * fix: use importlib.metadata to check mcp version in smoke test Agent-Logs-Url: https://github.com/cloudengine-labs/devops_os/sessions/67dfed60-b36b-48f1-83f5-84cca466abb9 Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com> * Update tests/test_mcp_protocol.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update tests/test_mcp_protocol.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/workflows/mcp-setup-smoke.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/workflows/mcp-setup-smoke.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com> Co-authored-by: Saravanan Gnanaguru <g.gsaravanan@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Member
Author
|
@copilot apply changes based on this feedback |
Agent-Logs-Url: https://github.com/cloudengine-labs/devops_os/sessions/a2bcc76b-f5a7-421e-9984-542b39e55436 Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
Contributor
Done in 8401da8. Replaced # Download the setup script
curl -fsSLo setup_devops_os_mcp.sh https://raw.githubusercontent.com/cloudengine-labs/devops_os/main/mcp_server/setup_devops_os_mcp.sh
# (Optional but recommended) Inspect the script before running it
less setup_devops_os_mcp.sh
# Run the setup script
bash setup_devops_os_mcp.sh |
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
mcp_server/README.mdwith clear, beginner-friendly step-by-step setup guides for every major MCP-compatible AI tool: Claude Code CLI, Claude Desktop, Cursor, VS Code + GitHub Copilot, Windsurf, and Zedsetup_devops_os_mcp.sh: replaced hardcoded~/gsdev/devops_ospath with configurableINSTALL_DIR(default~/devops_os), added--localflag for users already inside a clone, added--helpoutput and Python version check.mcp.json— Claude Code.cursor/mcp.json— Cursor IDE.vscode/mcp.json— VS Code Copilotgenerate_unittest_configto the tools table inmcp_server/README.mdREADME.md, replaced with acurl | bashone-liner and--localshortcut.gitignoreto track shareable IDE MCP configs while still ignoring personal IDE settingsTest plan
generate_github_actions_workflow,generate_k8s_config,generate_unittest_config)setup_devops_os_mcp.sh --helpprints usage correctlysetup_devops_os_mcp.sh --localresolves to the correct repo root.cursor/mcp.jsonand.vscode/mcp.jsonare committed (gitignore exceptions work)🤖 Generated with Claude Code