bd48814021
Clean up and organize the flask-shopdb repository for better maintainability and discoverability: ## Changes - Update .gitignore for build artifacts (publish/, data/, 122M total) - Reorganize .claude/ into 6 subdirectories with README navigation - Consolidate overlapping MCP setup guides into MCP-QUICK-START.md - Move deployment docs from root to docs/deployment/ - Archive dated status reports to .claude/archived/ - Delete temporary files (logs, backups, empty reports, ~50K) ## New Structure .claude/ organized into: - setup/ - MCP, VM, Hyper-V, GitHub setup guides + scripts (17 files) - plans/ - Feature plans and protocols (5 files) - maintenance/ - Deployment checklists and reports (4 files) - archived/ - Historical documentation (9 files) - skills/ - Claude Code automation (5 files) - workflows/ - Security audit workflow (1 file) docs/deployment/ created with 6 deployment guides: - LOCAL-DEV-SETUP.md, DOCKER-SETUP.md, DOCKER-PREBUILT-APPROACH.md - PRODUCTION-READINESS.md, DEPLOY-TO-VM.md, README.md Root directory cleaned to essential docs only: - CLAUDE.md, README.md, CONTRIBUTING.md, CHANGELOG.md Benefits: - Clear navigation via README.md in each subdirectory - No duplicate/overlapping documentation - Large artifacts properly gitignored (won't bloat repository) - Historical context preserved in archived/ See .claude/CLEANUP-SUMMARY.md for complete details. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
73 lines
1.9 KiB
Markdown
73 lines
1.9 KiB
Markdown
# MCP Quick Start Guide
|
|
|
|
Quick setup for ShopDB MCP (Model Context Protocol) servers.
|
|
|
|
## What is MCP?
|
|
|
|
MCP extends Claude Code with external tool access. ShopDB uses 5 MCP servers:
|
|
|
|
| Server | Purpose |
|
|
|--------|---------|
|
|
| **gortex** | Code intelligence and project management |
|
|
| **mysql** | Database access and queries |
|
|
| **browser** | Web automation and testing |
|
|
| **vm** | VM automation and deployment |
|
|
| **coordinator** | Multi-agent coordination |
|
|
|
|
## Quick Setup
|
|
|
|
### 1. Run Automated Setup
|
|
|
|
```powershell
|
|
cd flask-shopdb
|
|
.\.claude\quick-start-mcp.ps1
|
|
```
|
|
|
|
This installs all required packages and verifies connectivity.
|
|
|
|
### 2. Configure GitHub Token
|
|
|
|
```bash
|
|
# Create token at: https://github.com/settings/tokens/new
|
|
# Scopes needed: repo, read:org
|
|
|
|
# Set environment variable (Windows)
|
|
setx GITHUB_PERSONAL_ACCESS_TOKEN "ghp_YOUR_TOKEN_HERE"
|
|
|
|
# Or add to shell profile (Git Bash)
|
|
echo 'export GITHUB_PERSONAL_ACCESS_TOKEN="ghp_YOUR_TOKEN_HERE"' >> ~/.bashrc
|
|
```
|
|
|
|
### 3. Verify Setup
|
|
|
|
```powershell
|
|
.\.claude\test-mcp-servers.ps1
|
|
```
|
|
|
|
Expected: All servers respond OK.
|
|
|
|
### 4. Restart Claude Code
|
|
|
|
Close and reopen Claude Code to load MCP servers.
|
|
|
|
## Troubleshooting
|
|
|
|
**Problem**: GitHub authorization error
|
|
**Fix**: Set `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable and restart
|
|
|
|
**Problem**: MySQL connection fails
|
|
**Fix**: Start MySQL with `docker-compose up -d db` or `start-dev.cmd`
|
|
|
|
**Problem**: VM connection fails
|
|
**Fix**: Check VM is running and SSH is enabled (see `setup-vm-ssh.md`)
|
|
|
|
**Problem**: Coordinator not connecting
|
|
**Fix**: Verify coordinator server is running and network is accessible
|
|
|
|
## More Documentation
|
|
|
|
- `INDEX-MCP-DOCS.md` - Complete documentation index
|
|
- `MCP-INTEGRATION-GUIDE.md` - Detailed integration patterns and workflows
|
|
- `MCP-COORDINATOR-CONNECTION-GUIDE.md` - Multi-agent coordination setup
|
|
- `MCP-COORDINATOR-EVALUATION.md` - Coordinator capabilities and evaluation
|