Reference
Complete technical reference for the protoPen API, tools, and configuration.
API
- API Endpoints -- All HTTP endpoints with request/response formats.
- Chat Commands -- Slash commands available in the chat UI.
- Integrated Terminal -- The
/ws/terminalPTY WebSocket: auth, wire protocol, and security.
Tools
- Tools -- All agent tools and their actions.
- Adding a Tool -- Scaffold (
scripts/new_tool.py) + the impl/registration pattern. - Playbooks -- Declarative tool-chain recipes, modes, and the operator firing gate.
- Goals (Autonomy) -- Verifier-backed goal mode:
/goal, theset_goaltool, and the re-invocation loop. - Target Intel -- Target intelligence database schema (9 SQLite tables).
Configuration
- Engagement Modes -- PASSIVE, ACTIVE, REDTEAM mode definitions and risk gating.
- Environment Variables -- All environment variables and their purposes.
- Configuration Files -- Config file locations and structure.