Skip to content

Commit 76e6f3d

Browse files
chefgsclaude
andcommitted
docs(mcp): improve MCP setup for beginners across all AI tools
- 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>
1 parent 7316380 commit 76e6f3d

7 files changed

Lines changed: 447 additions & 59 deletions

File tree

.cursor/mcp.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"mcpServers": {
3+
"devops-os": {
4+
"command": ".venv/bin/python",
5+
"args": ["-m", "mcp_server.server"],
6+
"cwd": ".",
7+
"env": {
8+
"PYTHONPATH": "."
9+
}
10+
}
11+
}
12+
}

.gitignore

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,15 @@ pytestdebug.log
6262
*.iws
6363
.idea_modules/
6464

65-
# VS Code
66-
.vscode/
65+
# VS Code (ignore personal settings, track shared MCP config)
66+
.vscode/*
67+
!.vscode/mcp.json
6768
*.code-workspace
6869

70+
# Cursor (ignore personal settings, track shared MCP config)
71+
.cursor/*
72+
!.cursor/mcp.json
73+
6974
# Spyder
7075
.spyderproject
7176
.spyproject

.mcp.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"mcpServers": {
3+
"devops-os": {
4+
"command": ".venv/bin/python",
5+
"args": ["-m", "mcp_server.server"],
6+
"env": {
7+
"PYTHONPATH": "."
8+
}
9+
}
10+
}
11+
}

.vscode/mcp.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"servers": {
3+
"devops-os": {
4+
"type": "stdio",
5+
"command": ".venv/bin/python",
6+
"args": ["-m", "mcp_server.server"],
7+
"cwd": ".",
8+
"env": {
9+
"PYTHONPATH": "."
10+
}
11+
}
12+
}
13+
}

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -209,17 +209,28 @@ Single Cli Command for Platform Engineering Capabilities - Dev Container and CIC
209209

210210
---
211211

212-
### 6 — Use with AI (MCP Server) - **WIP**
212+
### 6 — Use with AI (MCP Server)
213+
214+
Connect DevOps-OS tools to any MCP-compatible AI assistant: **Claude Code, Claude Desktop, Cursor, VS Code Copilot, Windsurf, and Zed**.
215+
216+
**Fastest setup (Claude Code CLI):**
213217

214218
```bash
215-
pip install -r mcp_server/requirements.txt
216-
python mcp_server/server.py
219+
curl -fsSL https://raw.githubusercontent.com/cloudengine-labs/devops_os/main/mcp_server/setup_devops_os_mcp.sh | bash
217220
```
218221

219-
Add to your `claude_desktop_config.json` and ask Claude:
220-
> *"Generate a complete CI/CD GitHub Actions workflow for my Python API with Kubernetes deployment using ArgoCD."*
222+
Already cloned the repo? Run locally instead:
223+
224+
```bash
225+
bash mcp_server/setup_devops_os_mcp.sh --local
226+
```
227+
228+
Then ask your AI assistant:
229+
> *"Generate a complete GitHub Actions CI/CD workflow for my Python API with Kubernetes deployment using ArgoCD."*
230+
231+
**[Full setup guide →](mcp_server/README.md)** — covers Claude Desktop, Cursor, VS Code, Windsurf, Zed, and troubleshooting.
221232

222-
See **[mcp_server/README.md](mcp_server/README.md)** for full setup and **[skills/README.md](skills/README.md)** for Claude API & OpenAI function-calling examples.
233+
See **[skills/README.md](skills/README.md)** for Claude API & OpenAI function-calling examples.
223234

224235
---
225236

0 commit comments

Comments
 (0)