|
| 1 | +# MCP Manager Quickstart Guide |
| 2 | + |
| 3 | +Get started managing MCP (Model Context Protocol) servers in Claude Code in under 5 minutes. |
| 4 | + |
| 5 | +## What is MCP Manager? |
| 6 | + |
| 7 | +MCP Manager helps you configure, enable, and disable MCP servers through simple commands or natural conversation with Claude. |
| 8 | + |
| 9 | +**Two ways to use it:** |
| 10 | +1. **Conversational** (recommended): "List my MCPs", "Enable the filesystem server" |
| 11 | +2. **CLI**: Direct commands for scripts and automation |
| 12 | + |
| 13 | +## Quick Start (CLI) |
| 14 | + |
| 15 | +### 1. List Your Current MCPs |
| 16 | + |
| 17 | +```bash |
| 18 | +cd .claude/scenarios |
| 19 | +python3 -m mcp-manager.cli list |
| 20 | +``` |
| 21 | + |
| 22 | +**Output:** |
| 23 | +``` |
| 24 | +No MCP servers configured |
| 25 | +``` |
| 26 | + |
| 27 | +### 2. Add Your First MCP Server |
| 28 | + |
| 29 | +Let's add the filesystem MCP server: |
| 30 | + |
| 31 | +```bash |
| 32 | +python3 -m mcp-manager.cli add filesystem npx -- -y @modelcontextprotocol/server-filesystem |
| 33 | +``` |
| 34 | + |
| 35 | +**Output:** |
| 36 | +``` |
| 37 | +Created backup: settings_backup_20251124_020634_786095.json |
| 38 | +Successfully added server: filesystem (enabled) |
| 39 | +``` |
| 40 | + |
| 41 | +### 3. List Servers Again |
| 42 | + |
| 43 | +```bash |
| 44 | +python3 -m mcp-manager.cli list |
| 45 | +``` |
| 46 | + |
| 47 | +**Output:** |
| 48 | +``` |
| 49 | ++-----------------+---------+---------------------------------------------+---------+----------+ |
| 50 | +| Name | Command | Args | Enabled | Env Vars | |
| 51 | ++-----------------+---------+---------------------------------------------+---------+----------+ |
| 52 | +| filesystem | npx | -y @modelcontextprotocol/server-filesyst... | Yes | (none) | |
| 53 | ++-----------------+---------+---------------------------------------------+---------+----------+ |
| 54 | +``` |
| 55 | + |
| 56 | +### 4. Show Server Details |
| 57 | + |
| 58 | +```bash |
| 59 | +python3 -m mcp-manager.cli show filesystem |
| 60 | +``` |
| 61 | + |
| 62 | +**Output:** |
| 63 | +``` |
| 64 | +Server: filesystem |
| 65 | +======================= |
| 66 | +Command: npx |
| 67 | +Args: -y @modelcontextprotocol/server-filesystem |
| 68 | +Enabled: Yes |
| 69 | +
|
| 70 | +Environment Variables: (none) |
| 71 | +``` |
| 72 | + |
| 73 | +### 5. Disable a Server |
| 74 | + |
| 75 | +```bash |
| 76 | +python3 -m mcp-manager.cli disable filesystem |
| 77 | +``` |
| 78 | + |
| 79 | +**Output:** |
| 80 | +``` |
| 81 | +Created backup: settings_backup_20251124_020747_827593.json |
| 82 | +Successfully disabled server: filesystem |
| 83 | +``` |
| 84 | + |
| 85 | +### 6. Re-enable a Server |
| 86 | + |
| 87 | +```bash |
| 88 | +python3 -m mcp-manager.cli enable filesystem |
| 89 | +``` |
| 90 | + |
| 91 | +**Output:** |
| 92 | +``` |
| 93 | +Created backup: settings_backup_20251124_020759_130192.json |
| 94 | +Successfully enabled server: filesystem |
| 95 | +``` |
| 96 | + |
| 97 | +### 7. Remove a Server |
| 98 | + |
| 99 | +```bash |
| 100 | +python3 -m mcp-manager.cli remove filesystem --force |
| 101 | +``` |
| 102 | + |
| 103 | +**Output:** |
| 104 | +``` |
| 105 | +Created backup: settings_backup_20251124_020811_018707.json |
| 106 | +Successfully removed server: filesystem |
| 107 | +``` |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## Quick Start (Conversational) |
| 112 | + |
| 113 | +Just talk to Claude naturally: |
| 114 | + |
| 115 | +``` |
| 116 | +You: "List all my MCPs" |
| 117 | +Claude: [Shows formatted list of MCP servers] |
| 118 | +
|
| 119 | +You: "Add the filesystem MCP server" |
| 120 | +Claude: [Guides you through interactive setup] |
| 121 | +
|
| 122 | +You: "Enable the filesystem server" |
| 123 | +Claude: [Enables the server and confirms] |
| 124 | +
|
| 125 | +You: "Show me the filesystem MCP details" |
| 126 | +Claude: [Displays server configuration] |
| 127 | +``` |
| 128 | + |
| 129 | +**The skill automatically activates when you mention "MCP" or related keywords.** |
| 130 | + |
| 131 | +--- |
| 132 | + |
| 133 | +## Common MCP Servers |
| 134 | + |
| 135 | +### Filesystem MCP |
| 136 | +```bash |
| 137 | +python3 -m mcp-manager.cli add filesystem npx -- -y @modelcontextprotocol/server-filesystem |
| 138 | +``` |
| 139 | + |
| 140 | +### GitHub MCP |
| 141 | +```bash |
| 142 | +python3 -m mcp-manager.cli add github npx -- -y @modelcontextprotocol/server-github |
| 143 | +``` |
| 144 | + |
| 145 | +### Puppeteer MCP (Browser Automation) |
| 146 | +```bash |
| 147 | +python3 -m mcp-manager.cli add puppeteer npx -- -y @modelcontextprotocol/server-puppeteer |
| 148 | +``` |
| 149 | + |
| 150 | +### Azure MCP (with environment variables) |
| 151 | +```bash |
| 152 | +python3 -m mcp-manager.cli add azure npx -- -y @modelcontextprotocol/server-azure \ |
| 153 | + --env AZURE_SUBSCRIPTION_ID=your-sub-id \ |
| 154 | + --env AZURE_TENANT_ID=your-tenant-id |
| 155 | +``` |
| 156 | + |
| 157 | +--- |
| 158 | + |
| 159 | +## Key Commands Reference |
| 160 | + |
| 161 | +| Command | Purpose | Example | |
| 162 | +|---------|---------|---------| |
| 163 | +| `list` | Show all servers | `python3 -m mcp-manager.cli list` | |
| 164 | +| `add` | Add new server | `python3 -m mcp-manager.cli add <name> <command> <args...>` | |
| 165 | +| `enable` | Enable server | `python3 -m mcp-manager.cli enable <name>` | |
| 166 | +| `disable` | Disable server | `python3 -m mcp-manager.cli disable <name>` | |
| 167 | +| `show` | Show details | `python3 -m mcp-manager.cli show <name>` | |
| 168 | +| `remove` | Remove server | `python3 -m mcp-manager.cli remove <name>` | |
| 169 | +| `validate` | Check config | `python3 -m mcp-manager.cli validate` | |
| 170 | +| `export` | Export config | `python3 -m mcp-manager.cli export backup.json` | |
| 171 | +| `import` | Import config | `python3 -m mcp-manager.cli import backup.json` | |
| 172 | + |
| 173 | +--- |
| 174 | + |
| 175 | +## Safety Features |
| 176 | + |
| 177 | +Every modification: |
| 178 | +- **Creates automatic backup** (timestamped) |
| 179 | +- **Uses atomic writes** (no partial updates) |
| 180 | +- **Validates configuration** before writing |
| 181 | +- **Rolls back on errors** (restores from backup) |
| 182 | + |
| 183 | +**Backups are stored in:** `.claude/backups/settings_backup_*.json` |
| 184 | + |
| 185 | +--- |
| 186 | + |
| 187 | +## Next Steps |
| 188 | + |
| 189 | +- **Full documentation**: See [README.md](./README.md) |
| 190 | +- **Developer guide**: See [HOW_TO_CREATE_YOUR_OWN.md](./HOW_TO_CREATE_YOUR_OWN.md) |
| 191 | +- **Examples**: See [examples/basic_usage.py](./examples/basic_usage.py) |
| 192 | + |
| 193 | +--- |
| 194 | + |
| 195 | +**Ready to manage your MCPs! Start with:** `python3 -m mcp-manager.cli list` |
0 commit comments