Paca Documentation

Pages

1. OverviewWhat Paca exposes, runtime surfaces (web, API, realtime, MCP, ai-agent), and the shortest path from install to first project and API key.
2. InstallationPrerequisites, install script, manual Docker Compose setup, required secrets, and optional stack scaling (external Postgres, S3, no ai-agent).
3. QuickstartFirst successful run: start the stack, log in as admin, create a project, generate an API key, and verify health endpoints.
4. Platform architectureMonorepo runtime areas, service boundaries, Valkey event decoupling, and nginx gateway routing between web, API, realtime, and storage.
5. Interaction viewsUnified view and task-list model for sprint, backlog, and timeline contexts; query parameters, manual ordering, and shared REST paths.
6. AI agentsAgent members, trigger types, OpenHands conversation lifecycle, Docker isolation, Valkey streams, and how agents participate as project teammates.
7. Plugin systemWASM backend sandbox, frontend extension points, MCP plugin tools, capability permissions, and marketplace-driven install lifecycle.
8. Deploy productionProduction Docker Compose topology, nginx gateway, storage backends (MinIO vs S3), secret generation, and scaling optional services.
9. Local developmentDev Compose stack, hot-reload per service, host-side run commands, infra-only mode, and port map through the nginx gateway.
10. Connect MCP serverConfigure @paca-ai/paca-mcp with npx for Claude Desktop, VS Code, or any MCP client; env vars, agent mode, and plugin tool loading.
11. Claude Code skillsInstall /paca slash commands, wire the MCP server, available skill routes, and task-reference resolution patterns from skills/paca.
12. Configure AI agentsCreate agent types and project agents, set LLM and MCP config, wire repository access via plugin adapters, and control conversation lifecycle.
13. Build a pluginEnd-to-end plugin authoring: plugin.json manifest, WASM backend, frontend extension points, migrations, build output, and local install.
14. Install marketplace pluginsInstall plugins from the Paca-AI/paca-plugins catalog via the admin UI or API; artifact layout, migrations, and filesystem install scripts.
15. REST API referenceVersioned /api/v1 paths, auth cookies and bearer tokens, response envelopes, pagination, and implemented endpoint catalog by resource.
16. Task activity APIUnified activity and comment feed, activity_type values, JSONB content shapes, diff/revert semantics, and list/mutation endpoints.
17. Realtime eventsSocket.IO connection auth, Valkey pub/sub fan-out, project and conversation rooms, and domain event payloads including agent monitoring.
18. MCP tools referenceAll @paca-ai/paca-mcp tool names by category, input schemas, agent-mode constraints, and dynamically loaded plugin tools.
19. Configuration referenceEnvironment variables across API, web gateway, realtime, and ai-agent: JWT, storage, plugins, encryption, cache TTLs, and internal keys.
20. Plugin SDK referenceTyped APIs for @paca-ai/plugin-sdk-react, plugin-sdk-go host bridge, and @paca-ai/plugin-sdk-mcp; extension points and scoped HTTP clients.
21. TroubleshootingCommon install and runtime failures: health checks, auth cookies, Valkey connectivity, storage misconfiguration, and MCP connection errors.
22. Upgrade and migrationPull new images, automatic DB migrations on API startup, compose project rename volume migration, and version upgrade verification signals.
23. ContributingRepository layout, dev prerequisites, PR checklist, test surfaces (Go integration, Playwright e2e), and documentation update expectations.