Start here — Development & Integration
Target Group: Developers, IT, Agencies, Cursor / Claude / MCP — not the editorial guide (which is located under the Navbar Editorial).
Documentation Guideline: Documentation Target Groups.
Architecture in 30 Seconds
| Layer | Path | Role |
|---|---|---|
| Data | packages/database (Prisma) | Schema, Migrations — write only via Dashboard |
| Core | apps/dashboard | APIs, Auth, Business Logic, only direct database access |
| Channels | apps/center-website, apps/digital-signage, apps/center-manager | API clients to the Dashboard |
| Shared | packages/ui, packages/ai-context, packages/wayfinding, … | Reusability |
| MCP | packages/mcp-cockpit-os, packages/mcp-cockpit-remote | Claude/Cursor tools against APIs |
| Docs | cockpit-docs/ | This site |
Deep Dive: Platform Overview · Maturity & Operation.
Repo Setup
# Monorepo Root — Node >= 22.13, pnpm
pnpm install
pnpm --filter dashboard dev # Dashboard locally
| File | Purpose |
|---|---|
README.md | Root Overview |
db_structure.md | Schema Reference (maintain after DB changes) |
render.yaml | Deployment Services |
.cursor/rules/ | Cursor Rules (Documentation requirement, DB Safety, Next Routes, …) |
scripts/check-next-dynamic-route-slugs.mjs | Mandatory before new API routes |
APIs & Contracts (binding)
| Contract | When |
|---|---|
| Public Center Website API | v0, external frontends, public reads |
| AgencyOS Integration | Partners, Magic Link, Content Push, Audit |
| WordPress Push | Plugin Sync |
| Dashboard API Center Scoping | Session, Roles, centerId |
| OpenAPI | /openapi/agencyos-integration.yaml, /openapi/public-wayfinding-read.yaml |
| JSON | /ai-integration/cockpit-api-capabilities.json |
Gap analyses (internal): Public API Gap · Center Website Bundle.
MCP & AI Coding Tools
| Package | Transport | Documentation |
|---|---|---|
packages/mcp-cockpit-os | Stdio (Claude Desktop, Cursor) | README |
packages/mcp-cockpit-remote | HTTP (Claude Connector) | Package README |
packages/mcp-cockpit-os/V0_CUSTOM_INSTRUCTIONS.md | — | v0 Instruction Sources (Repo) |
Env (Names, no values in documentation): COCKPIT_DASHBOARD_BASE_URL, COCKPIT_AGENCYOS_API_KEY, COCKPIT_ALLOW_CONTENT_PUSH, COCKPIT_MCP_HTTP_BEARER (Remote).
MCP Server Instructions refer to the Public API contract — keep Contract and MCP in sync with tool changes.
Editorial (Claude without code): Claude & MCP — different target group.
Extending the System — Typical Entry Points
| Change | Where to Start |
|---|---|
| New Dashboard Menu / Module | apps/dashboard/src/config/navigation.ts, lib/modules.ts → Navigation Docs |
| New Public API Route | apps/dashboard/src/app/api/... — one dynamic slug per level |
| Center Website Feature | apps/center-website + possibly Public API |
| New MCP Tool | packages/mcp-cockpit-os/src/register-cockpit-tools.ts |
| Prisma Schema | packages/database — additive migration, db_structure.md |
| Website Template | apps/center-website + Templates |
| WordPress | Theme Development |
Tutorial: Getting Started · Plugins: Plugin Overview.
MEC / Legacy (only for Migration)
Collapsed in the sidebar: CSS checklists, mec-import, mec-shared-components — not the entry point for new features.
Next Steps
Contact: sb@schickma.de
Nutzungsstatistik: Seitenaufrufe werden anonymisiert erfasst. Im Umami-Dashboard nach diesem Pfad filtern: /en/developer-guide/start-hier