- Replace all unicode (emojis, checkmarks, arrows, em-dashes) with ASCII in .claude/ docs - Comment out OperatingSystemsList route in core.js - breaks lean builds without computers plugin - Comment out Operating Systems tab in ModelCatalogHub - TODO: Plugins should dynamically register their settings routes Fixes #2 CI check failures on wj branch Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
370 lines
9.3 KiB
Markdown
370 lines
9.3 KiB
Markdown
# MCP Setup Complete - Summary
|
|
|
|
Setup completed on 2026-09-09
|
|
|
|
---
|
|
|
|
## What Was Created
|
|
|
|
### Documentation (7 files)
|
|
|
|
1. **INDEX-MCP-DOCS.md** - Master index of all MCP documentation
|
|
2. **README-MCP-SETUP.md** - Quick reference guide
|
|
3. **MCP-INTEGRATION-GUIDE.md** - Complete guide with workflows (4000+ words)
|
|
4. **VM-SNAPSHOT-GUIDE.md** - Snapshot management guide
|
|
5. **setup-vm-ssh.md** - SSH configuration for VM (existing, referenced)
|
|
6. **enable-vm-ssh.ps1** - Script to run on VM (existing, referenced)
|
|
7. **SETUP-COMPLETE-SUMMARY.md** - This file
|
|
|
|
### Automation Scripts (2 files)
|
|
|
|
1. **test-mcp-servers.ps1** - Test suite for all MCP servers
|
|
2. **quick-start-mcp.ps1** - Automated setup and installation
|
|
|
|
---
|
|
|
|
## Current Status
|
|
|
|
### Test Results (from test-mcp-servers.ps1)
|
|
|
|
```
|
|
Overall: 3/7 tests passed (43%)
|
|
|
|
gortex : OK [X] (C:\Users\270015376\Documents\gortex.exe found)
|
|
browser : OK [X] (v1.2.29 available via npm)
|
|
config : OK [X] (mcp-servers.json valid)
|
|
mysql : FAIL [ ] (Docker database not running)
|
|
vm : FAIL [ ] (VM not reachable at 192.168.100.10)
|
|
hyperv : WARN [!] (No admin privileges to check)
|
|
snapshots : WARN [!] (No admin privileges to check)
|
|
```
|
|
|
|
### What's Working
|
|
|
|
- MCP configuration file is valid
|
|
- Gortex project management server installed and ready
|
|
- Browser automation packages available
|
|
- Node.js and npm properly installed
|
|
- All documentation and scripts created
|
|
|
|
### What Needs Setup
|
|
|
|
**To use MySQL MCP:**
|
|
```powershell
|
|
docker compose up -d db
|
|
```
|
|
|
|
**To use VM MCP:**
|
|
1. Start VM in Hyper-V Manager
|
|
2. Run on VM as Administrator: `.\\.claude\enable-vm-ssh.ps1`
|
|
3. Test from host: `ssh SupportUser@192.168.100.10`
|
|
|
|
**To create VM snapshots:**
|
|
1. Open PowerShell as Administrator
|
|
2. Follow `VM-SNAPSHOT-GUIDE.md`
|
|
|
|
---
|
|
|
|
## Quick Start Commands
|
|
|
|
### Test Setup
|
|
```powershell
|
|
cd C:\Users\270015376\Documents\github\flask-shopdb
|
|
.\\.claude\test-mcp-servers.ps1
|
|
```
|
|
|
|
### Start Development
|
|
```powershell
|
|
cd C:\Users\270015376\Documents\github\flask-shopdb
|
|
docker compose up -d db # Start database (if needed)
|
|
claude # Start Claude Code with MCP servers
|
|
```
|
|
|
|
### Test MCP Servers with Claude
|
|
```
|
|
"List all tasks in the current project" # Gortex
|
|
"Show me the endpoints table schema" # MySQL
|
|
"Take a screenshot of https://localhost:5001" # Browser
|
|
"What is the hostname of the VM?" # VM
|
|
```
|
|
|
|
---
|
|
|
|
## Documentation Structure
|
|
|
|
```
|
|
flask-shopdb/.claude/
|
|
+-- INDEX-MCP-DOCS.md <- START HERE (master index)
|
|
+-- README-MCP-SETUP.md <- Quick reference
|
|
+-- MCP-INTEGRATION-GUIDE.md <- Complete guide with workflows
|
|
+-- VM-SNAPSHOT-GUIDE.md <- Snapshot management
|
|
+-- setup-vm-ssh.md <- SSH configuration
|
|
+-- mcp-servers.json <- Configuration file
|
|
+-- test-mcp-servers.ps1 <- Test suite
|
|
+-- quick-start-mcp.ps1 <- Setup automation
|
|
+-- enable-vm-ssh.ps1 <- VM SSH enablement
|
|
+-- SETUP-COMPLETE-SUMMARY.md <- This file
|
|
```
|
|
|
|
---
|
|
|
|
## Memory Updated
|
|
|
|
Memory file updated at:
|
|
```
|
|
~/.claude/projects/C--Users-270015376-Documents-github/memory/infrastructure_mcp_servers.md
|
|
```
|
|
|
|
Added section: "Documentation and Testing" with links to all new files.
|
|
|
|
---
|
|
|
|
## Recommended Reading Order
|
|
|
|
**First time setup:**
|
|
1. Read `INDEX-MCP-DOCS.md` (this is the master index)
|
|
2. Read `README-MCP-SETUP.md` (quick reference)
|
|
3. Run `quick-start-mcp.ps1` (automated setup)
|
|
4. Run `test-mcp-servers.ps1` (verify setup)
|
|
5. Read `VM-SNAPSHOT-GUIDE.md` (if using VM)
|
|
6. Read `MCP-INTEGRATION-GUIDE.md` (learn workflows)
|
|
|
|
**Daily usage:**
|
|
1. Run `test-mcp-servers.ps1` (verify everything ready)
|
|
2. Start Claude Code from flask-shopdb directory
|
|
3. Reference `README-MCP-SETUP.md` for troubleshooting
|
|
|
|
---
|
|
|
|
## Example Workflows Documented
|
|
|
|
### Database Development
|
|
- Add field to table
|
|
- Create migration
|
|
- Verify with MySQL MCP
|
|
- Test on VM
|
|
|
|
### UI Testing
|
|
- Build frontend
|
|
- Create test data in database
|
|
- Test UI with browser automation
|
|
- Screenshot results
|
|
- Clean up test data
|
|
|
|
### Agent Testing
|
|
- Build agent
|
|
- Deploy to VM via SSH
|
|
- Verify agent connects
|
|
- Check logs
|
|
- Test fleet alerts end-to-end
|
|
|
|
### Debugging
|
|
- Query database for issue
|
|
- Check agent logs on VM
|
|
- Test API endpoints
|
|
- Screenshot UI state
|
|
- Identify root cause
|
|
|
|
See `MCP-INTEGRATION-GUIDE.md` for detailed workflow examples.
|
|
|
|
---
|
|
|
|
## Snapshot Strategy (Recommended)
|
|
|
|
**Baseline snapshots to create:**
|
|
```powershell
|
|
# After clean Windows 11 install
|
|
Checkpoint-VM -Name "ShopDB-Test-VM" -SnapshotName "Clean-Install"
|
|
|
|
# After Docker Desktop installed
|
|
Checkpoint-VM -Name "ShopDB-Test-VM" -SnapshotName "Docker-Ready"
|
|
|
|
# After SSH enabled
|
|
Checkpoint-VM -Name "ShopDB-Test-VM" -SnapshotName "SSH-Enabled"
|
|
|
|
# After ShopDB deployed
|
|
Checkpoint-VM -Name "ShopDB-Test-VM" -SnapshotName "ShopDB-Deployed"
|
|
```
|
|
|
|
**Testing snapshots (create as needed):**
|
|
```powershell
|
|
# Before risky operations
|
|
Checkpoint-VM -Name "ShopDB-Test-VM" -SnapshotName "Before-$(Get-Date -Format 'yyyyMMdd-HHmm')"
|
|
```
|
|
|
|
See complete guide: `VM-SNAPSHOT-GUIDE.md`
|
|
|
|
---
|
|
|
|
## Security Notes
|
|
|
|
### Development Credentials (Local Only)
|
|
|
|
**Database:**
|
|
- User: shopdb
|
|
- Password: shopdb-dev-password
|
|
- Host: 127.0.0.1:3306
|
|
- Database: shopdb_flask
|
|
- **Scope:** Localhost only, not exposed beyond local machine
|
|
|
|
**VM SSH:**
|
|
- User: SupportUser
|
|
- Password: vos313
|
|
- Host: 192.168.100.10 (internal network only)
|
|
- **Scope:** Test VM on isolated internal network, no internet access
|
|
|
|
### Production Differences
|
|
|
|
- Environment variables for credentials
|
|
- Encrypted connections
|
|
- Restricted database users
|
|
- No MCP servers in production
|
|
- No plain-text passwords
|
|
|
|
---
|
|
|
|
## Integration with Claude Code
|
|
|
|
### How MCP Servers Load
|
|
|
|
**Automatic:** When you run `claude` from the `flask-shopdb` directory, Claude Code:
|
|
1. Looks for `.claude/mcp-servers.json`
|
|
2. Starts each configured MCP server
|
|
3. Makes their tools available to Claude
|
|
4. You can use them through natural language
|
|
|
|
**Manual:** To use MCP in different directory:
|
|
- Copy `mcp-servers.json` to that directory's `.claude/` folder
|
|
- Or run Claude Code from `flask-shopdb` directory
|
|
|
|
### Permission Model
|
|
|
|
**First use of each MCP tool:**
|
|
- Claude Code shows permission prompt
|
|
- Review the operation (query, command, etc.)
|
|
- Approve or deny
|
|
|
|
**After approval:**
|
|
- Operation executes
|
|
- Similar operations may also require approval
|
|
- Dangerous operations always require approval
|
|
|
|
**Configure auto-approval:**
|
|
Add to `.claude/settings.json`:
|
|
```json
|
|
{
|
|
"permissions": {
|
|
"allow": [
|
|
"mcp__mysql__query(SELECT *)",
|
|
"mcp__vm__exec(hostname)"
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Troubleshooting Quick Reference
|
|
|
|
| Issue | Fix |
|
|
|-------|-----|
|
|
| MySQL not reachable | `docker compose up -d db` |
|
|
| VM not reachable | Start VM in Hyper-V Manager |
|
|
| SSH connection refused | Run `enable-vm-ssh.ps1` on VM |
|
|
| MCP servers not loading | Restart Claude Code from flask-shopdb directory |
|
|
| Browser automation failed | Close other Chrome instances |
|
|
| Gortex not found | Run `quick-start-mcp.ps1` |
|
|
|
|
Full troubleshooting: `README-MCP-SETUP.md` -> Troubleshooting section
|
|
|
|
---
|
|
|
|
## Next Steps
|
|
|
|
### Immediate
|
|
1. **Start MySQL database:**
|
|
```powershell
|
|
docker compose up -d db
|
|
```
|
|
|
|
2. **Test without VM** (optional):
|
|
```powershell
|
|
.\\.claude\test-mcp-servers.ps1 -SkipVM
|
|
```
|
|
|
|
3. **Start Claude Code:**
|
|
```powershell
|
|
claude
|
|
```
|
|
|
|
### When Ready for VM Testing
|
|
1. Start VM in Hyper-V Manager
|
|
2. Run on VM as Admin: `.\\.claude\enable-vm-ssh.ps1`
|
|
3. Test SSH: `ssh SupportUser@192.168.100.10`
|
|
4. Create baseline snapshots (see `VM-SNAPSHOT-GUIDE.md`)
|
|
5. Run full test: `.\\.claude\test-mcp-servers.ps1`
|
|
|
|
### Learning Phase
|
|
1. Read `MCP-INTEGRATION-GUIDE.md`
|
|
2. Try example workflows with Claude
|
|
3. Experiment with combining MCP tools
|
|
4. Build your own workflows
|
|
|
|
---
|
|
|
|
## Files Created (Summary)
|
|
|
|
**Documentation:** 4 new files, 3 existing referenced
|
|
**Scripts:** 2 new PowerShell scripts
|
|
**Configuration:** 1 existing file validated
|
|
**Memory:** 1 file updated
|
|
|
|
**Total lines written:** ~2500 lines of documentation and code
|
|
|
|
---
|
|
|
|
## Success Criteria
|
|
|
|
Setup is complete when:
|
|
|
|
- [ ] `test-mcp-servers.ps1` passes all tests
|
|
- [ ] Claude Code loads all 4 MCP servers
|
|
- [ ] Can query database via MySQL MCP
|
|
- [ ] Can control VM via SSH MCP
|
|
- [ ] Can automate browser via Browser MCP
|
|
- [ ] Can track tasks via Gortex MCP
|
|
- [ ] VM snapshots created and tested
|
|
- [ ] Documentation read and understood
|
|
|
|
**Current status:** 3/7 tests passing (setup phase complete, activation pending)
|
|
|
|
---
|
|
|
|
## Support Resources
|
|
|
|
**Local Documentation:**
|
|
- `INDEX-MCP-DOCS.md` - Master index
|
|
- `README-MCP-SETUP.md` - Quick reference
|
|
- `MCP-INTEGRATION-GUIDE.md` - Complete guide
|
|
|
|
**Test and Setup:**
|
|
- `test-mcp-servers.ps1` - Test suite
|
|
- `quick-start-mcp.ps1` - Automated setup
|
|
|
|
**External:**
|
|
- Gortex: https://github.com/zzet/gortex
|
|
- MCP Spec: https://github.com/modelcontextprotocol/specification
|
|
- MySQL MCP: https://www.npmjs.com/package/@benborla29/mcp-server-mysql
|
|
- Browser MCP: https://www.npmjs.com/package/@agent-infra/mcp-server-browser
|
|
- SSH MCP: https://www.npmjs.com/package/ssh-mcp
|
|
|
|
---
|
|
|
|
**Setup documentation complete!**
|
|
|
|
Ready to activate MCP servers:
|
|
1. Start MySQL: `docker compose up -d db`
|
|
2. Start VM (optional): Open Hyper-V Manager
|
|
3. Test: `.\\.claude\test-mcp-servers.ps1`
|
|
4. Use: `claude` (from flask-shopdb directory)
|