Developer Documentation
These documents are for contributors and developers working on the MCPBox codebase. See CONTRIBUTING.md for development setup and guidelines.
Architecture & Design
| Document | Description |
|---|---|
| Architecture | Module map, data flow, database schema, Docker networks |
| Data Model | Database schema, entity relationships, design patterns |
| Auth Flow | Worker + Gateway authentication and authorization flow |
| Decisions | Architecture decision records (ADRs) |
| Security | Security model and operator best practices |
Reference
| Document | Description |
|---|---|
| API Contracts | Internal and external API contracts and schemas |
| Features | Feature inventory with status and test coverage |
| Testing | Test coverage map and infrastructure |
| Frontend Standards | UI style guide (colors, spacing, typography) |
| Frontend Architecture | Frontend implementation details |
Setup & Operations
| Document | Description |
|---|---|
| Production Deployment | Full deployment guide with all configuration options |
| Remote Access Setup | Detailed Cloudflare tunnel and VPC configuration |
| Setup Wizard | Cloudflare setup wizard implementation details |
| Incident Response | Operational runbooks for failure scenarios |