mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
docs(0.7.0): document Grok provider, self-heal, PR-reviewer across the RAG + how-to docs
Close the doc gaps the audit found in the agent knowledge base and the human walkthrough: - config-reference: add the Grok provider env table (host ~/.grok subscription mount, grok-build, idle-kill, cost cap) and the Self-Healing CI loop toggles. - agent-model: provider-aware Model Configuration (ANTHROPIC default / GROK) + add the pr_reviewer / prompter / secretary roles to the Roles table. - tool-permissions: 'three' -> five MCP servers (roboco-optimal, roboco-docs) + PR Reviewer / Prompter / Secretary tool sections. - new roles/pr-reviewer.md (the 22nd agent had no role doc); permissions + agent-uuids + task-tools 'PR Reviewer flow' all gain the role. - api-endpoints: drop the removed USAGE_UPDATE event (only USAGE_SNAPSHOT exists). - how-to: self-healing CI loop + Company Scorecard (ch.5), inbound external-PR review + CEO Supersede/Dismiss queue (ch.4). Every claim verified against current code by the audit (grok model grok-build, auth ~/.grok, no metered API; opencode fully removed).
This commit is contained in:
@@ -24,6 +24,9 @@
|
||||
| `developer` | Writes code |
|
||||
| `qa` | Reviews and tests |
|
||||
| `documenter` | Writes documentation |
|
||||
| `pr_reviewer` | Read-only reviewer of inbound external/fork + internal PRs (agent `pr-reviewer-1`) |
|
||||
| `prompter` | On-demand intake interviewer, human-only (agent `intake-1`) |
|
||||
| `secretary` | On-demand chief-of-staff, human-only (agent `secretary-1`) |
|
||||
| `system` | Internal orchestrator |
|
||||
|
||||
## Teams
|
||||
@@ -61,6 +64,8 @@ Stored in `model_config` JSON:
|
||||
- Temperature
|
||||
- Other settings
|
||||
|
||||
The **provider** selects the agent backend, resolved through the `ProviderRegistry` (`roboco/llm/providers/`). `ModelProvider` is `ANTHROPIC` (default — Claude Code), `GROK` (xAI's official `grok` CLI, model `grok-build`, on a SuperGrok subscription), `LOCAL`, `OLLAMA_CLOUD`, or `OPENAI` (reserved). An agent with no dedicated provider falls back to the built-in Claude Code spawn. Grok auth is the host `~/.grok` subscription mount (auto-refreshed by the orchestrator), not a metered API key.
|
||||
|
||||
## Agent-Specific Fields
|
||||
|
||||
| Field | Description |
|
||||
|
||||
@@ -64,6 +64,9 @@ delegate(assigned_to="00000000-0000-0000-0001-000000000001", ...)
|
||||
| `product-owner` | `00000000-0000-0000-0004-000000000002` |
|
||||
| `head-marketing` | `00000000-0000-0000-0004-000000000003` |
|
||||
| `auditor` | `00000000-0000-0000-0004-000000000004` |
|
||||
| `intake-1` (prompter) | `00000000-0000-0000-0004-000000000005` |
|
||||
| `secretary-1` | `00000000-0000-0000-0004-000000000006` |
|
||||
| `pr-reviewer-1` | `00000000-0000-0000-0004-000000000007` |
|
||||
|
||||
## CEO (0000)
|
||||
|
||||
|
||||
@@ -62,6 +62,33 @@ Environment variables for RoboCo (prefix: `ROBOCO_`).
|
||||
| `ROBOCO_LOCAL_LLM_BASE_URL` | `http://roboco-ollama:11434/v1` | OpenAI-compat API |
|
||||
| `ROBOCO_OLLAMA_BASE_URL` | `http://roboco-ollama:11434` | Native Ollama API |
|
||||
|
||||
## Grok provider (xAI)
|
||||
|
||||
Agents whose provider is `GROK` run xAI's official `grok` CLI. Auth is the host SuperGrok subscription (mounted `~/.grok`), not a metered API key.
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `ROBOCO_HOST_GROK_DIR` | `~/.grok` | Host dir holding `auth.json`, mounted into Grok agents; the orchestrator auto-refreshes the ~6h token in place. Set up once with `grok login`. |
|
||||
| `ROBOCO_GROK_CLI_MODEL` | `grok-build` | Grok CLI model id |
|
||||
| `ROBOCO_GROK_AGENT_IMAGE` | `roboco-agent-grok:latest` | Image for Grok delivery agents |
|
||||
| `ROBOCO_GROK_REASONING_EFFORT` | (blank) | Per-run reasoning-effort override; blank = the grok CLI default |
|
||||
| `ROBOCO_GROK_IDLE_KILL_SECONDS` | `900` | Kill + evict a Grok container that has been ACTIVE-yet-idle (no gateway verb) this long |
|
||||
| `ROBOCO_GROK_MAX_COST_USD` | `0.0` | Per-agent Grok cost ceiling (USD); `0` disables |
|
||||
|
||||
## Self-Healing CI loop
|
||||
|
||||
RoboCo watching its own repo's CI. All default-off / dormant.
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `ROBOCO_SELF_HEAL_ENABLED` | `false` | Master switch (detect + notify the CEO); off = the loop never runs and no CI is fetched |
|
||||
| `ROBOCO_SELF_HEAL_ORIGINATE_ENABLED` | `false` | Second opt-in: also open a PENDING fix task on a regression — CEO-gated, never auto-started/merged/deployed |
|
||||
| `ROBOCO_SELF_HEAL_PROJECT_SLUG` | (empty) | The registered project that IS RoboCo itself — the only repo it watches and fixes; empty = no-op |
|
||||
| `ROBOCO_SELF_HEAL_CI_WORKFLOW` | (empty) | GitHub Actions workflow to scope the CI signal to (e.g. `ci.yml`); empty = latest across all workflows |
|
||||
| `ROBOCO_SELF_HEAL_INTERVAL_SECONDS` | `1800` | Seconds between assessment passes |
|
||||
| `ROBOCO_SELF_HEAL_MAX_OPEN_TASKS` | `3` | Rolling cap on concurrently-open self-heal tasks |
|
||||
| `ROBOCO_SELF_HEAL_MAX_PER_CYCLE` | `1` | Max fix tasks originated per cycle |
|
||||
|
||||
## Security
|
||||
|
||||
| Variable | Default | Description |
|
||||
|
||||
@@ -12,6 +12,10 @@ What each role can do in the system.
|
||||
| MAIN_PM | main_pm |
|
||||
| CELL_PM | cell_pm |
|
||||
| CELL_MEMBER | developer, qa, documenter |
|
||||
| (read-only reviewer) | pr_reviewer |
|
||||
| (human-only) | prompter, secretary |
|
||||
|
||||
`pr_reviewer` is a board-adjacent, read-only role (QA level): it claims and posts inbound-PR reviews (`claim_pr_review` / `post_pr_review`) but creates, assigns, completes, and notifies nothing. `prompter` (intake) and `secretary` are **human-only** — they chat with the CEO and have only `note` + `evidence`, with no task or notification permissions; they don't appear in the action tables below.
|
||||
|
||||
## Task Permissions
|
||||
|
||||
|
||||
@@ -2,13 +2,15 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Agents call gateway verbs through three MCP servers, scoped per role:
|
||||
Agents call gateway verbs through up to five MCP servers, scoped per role:
|
||||
|
||||
| MCP server | Provides |
|
||||
|------------|----------|
|
||||
| `roboco-flow` | Lifecycle verbs (give_me_work, i_will_work_on, open_pr, complete, …) |
|
||||
| `roboco-do` | Content/write verbs (commit, note, say, dm, notify, evidence) |
|
||||
| `roboco-git-readonly` | Read-only git inspection (status, log, diff, branch_list) |
|
||||
| `roboco-optimal` | RAG (`roboco_ask_mentor`, `roboco_kb_search`) |
|
||||
| `roboco-docs` | Project docs file management (selected roles) |
|
||||
|
||||
Native shell git is blocked by the bash-guard hook for everyone. There is **no** `roboco_git_commit / _push / _create_pr / _merge_pr / _checkout` tool — write operations happen through the lifecycle verbs and the choreographer handles git as a side-effect.
|
||||
|
||||
@@ -80,6 +82,26 @@ The canonical source of role → verb mapping is `roboco/services/gateway/role_c
|
||||
|
||||
**Read-only git:** none.
|
||||
|
||||
## PR Reviewer
|
||||
|
||||
**Flow verbs:** `give_me_work`, `claim_pr_review`, `post_pr_review`, `i_am_idle` (read-only)
|
||||
|
||||
**Content verbs:** `note`, `evidence`, plus notification reads (`notify_list`, `notify_get`) and channel discovery — no `say` / `dm`: the change-request is posted server-side on the PR itself.
|
||||
|
||||
**Read-only git:** none.
|
||||
|
||||
**Workspace writes:** none — reviews inbound external/fork + internal PRs only.
|
||||
|
||||
## Prompter (Intake) & Secretary
|
||||
|
||||
Both are human-only roles — they chat with the CEO, not other agents.
|
||||
|
||||
**Flow verbs:** `i_am_idle` only.
|
||||
|
||||
**Content verbs:** `note`, `evidence` only (no `say` / `dm` / `notify`).
|
||||
|
||||
**Read-only git / workspace writes:** none.
|
||||
|
||||
## Tool Permissions Summary
|
||||
|
||||
| Capability | Dev | Doc | QA | Cell PM | Main PM | Board | Auditor |
|
||||
|
||||
Reference in New Issue
Block a user