366dfe123e
Refresh the Grok runtime README with the current flagship model invocation. - Update the optional Grok ACP command to use grok-4.6. - Document why the illustrative model identifier tracks the provider default. Files changed: plugins/fusion-plugin-grok-runtime/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) Fusion-Task-Id: FN-9015 Fusion-Task-Lineage: 6dd04810-fe06-4462-82b9-5abb38e229c0 Co-authored-by: Fusion (runfusion.ai) <noreply@runfusion.ai>
80 lines
6.6 KiB
Markdown
80 lines
6.6 KiB
Markdown
# fusion-plugin-grok-runtime
|
|
|
|
Grok CLI-backed provider/runtime plugin for Fusion. Agent sessions use **native ACP** (`grok agent stdio`) for realtime streaming, tool visibility, and multi-turn reuse.
|
|
|
|
## Install
|
|
|
|
This plugin ships bundled with Fusion and is auto-installed like the other
|
|
built-in runtime plugins. It shells out to an **operator-installed** `grok`
|
|
binary on PATH — Fusion never downloads or bundles the CLI itself.
|
|
|
|
- Canonical upstream: xAI official Grok CLI / Grok Build TUI (`grok --version` observed as `grok 0.2.93 (f00f96316d4b)`).
|
|
- Docs / homepage: https://grok.com/, https://docs.x.ai/, https://docs.x.ai/build/overview, and `grok --help` / `grok agent stdio --help`.
|
|
- ACP protocol: https://agentclientprotocol.com
|
|
- Release / download: operator-installed; Fusion resolves `grok` from PATH or `grokCliBinaryPath`.
|
|
- Binary name: `grok`.
|
|
- Checksum: `upstream-pending-verification` because Fusion does not download or pin the operator's binary.
|
|
|
|
The previously assumed `superagent-ai/grok-cli` contract is a different product that shares the `grok` binary name. This plugin targets xAI's official CLI contract.
|
|
|
|
## Contract summary
|
|
|
|
- Provider ID: `grok-cli`
|
|
- Binary probe: `grok --version`
|
|
- **Auth model — the `grok` CLI owns its own authentication; Fusion does not require a Fusion-visible API key to enable/use it (FN-7716).** Fusion additionally probes the `GROK_API_KEY` env var and `~/.grok/user-settings.json` → `{ "apiKey": "..." }` purely as a **non-blocking informational hint** (`apiKeyDetected`); it never gates Enable or the authenticated state. The direct xAI OpenAI-compatible streaming path (base URL `https://api.x.ai/v1`) still uses `$GROK_API_KEY` when present, independent of the CLI provider.
|
|
- Model discovery: `grok models` (plain text). The observed xAI shape is `Default model: <id>`, then `Available models:`, then `* <id> (default)` / `- <id>` bullet rows.
|
|
|
|
## Agent session path — ACP (primary)
|
|
|
|
`GrokRuntimeAdapter` drives xAI's native ACP server with a **vendored** ACP client
|
|
(copied under `src/acp/`, not imported from `fusion-plugin-acp-runtime`):
|
|
|
|
<!-- FNXC:GrokRuntimeDocs 2026-08-12-22:30: The optional-model line is an illustrative invocation, not a captured transcript, so it tracks the current flagship id (grok-4.6, seeded in packages/core/src/ai/grok-provider.ts). Observed grok models output elsewhere keeps its verbatim older ids. -->
|
|
```bash
|
|
grok agent stdio
|
|
# optional model:
|
|
grok agent -m grok-4.6 stdio
|
|
```
|
|
|
|
- **Realtime streaming** — ACP `session/update` notifications map to Fusion `onText` / `onThinking` / `onToolStart` / `onToolEnd` as chunks arrive (not buffered until process exit).
|
|
- **Multi-turn** — one `createSession` keeps the ACP connection; each `promptWithFallback` is a `session/prompt` on the same session.
|
|
- **Permissions** — Grok tool calls surface as `session/request_permission` and go through Fusion's per-category action gate.
|
|
- **Fusion tools (`fn_*`)** — engine `customTools` are exposed to Grok as MCP server `fusion-custom-tools` (executable bridge, not schema-only).
|
|
- **Operator MCP** — configured Fusion MCP servers (stdio/http/sse) are forwarded on ACP `session/new.mcpServers`.
|
|
- **Skills** — the bundled Fusion skill plus session `additionalSkillPaths` / requested skill names are staged into a trusted `--plugin-dir` plugin so Grok discovers them like a native plugin.
|
|
- **Env** — subprocess env is allow-listed (includes `HOME`/`PATH`/XDG so `~/.grok/auth.json` works, plus optional `XAI_API_KEY`/`GROK_API_KEY`). Full `process.env` is never inherited.
|
|
- **Auth implication:** because the `grok` binary resolves its own credentials for this path, a CLI-routed selection needs **no Fusion-visible `GROK_API_KEY`** when a cached grok.com session exists — unlike the direct xAI OpenAI-compatible streaming path.
|
|
|
|
See `docs/grok-cli-contract.md` for the full contract, failure history (FN-7790/FN-7796 headless paths), and diagnostics invariants.
|
|
|
|
## Routing Grok through the CLI runtime (FN-7725 / FN-7753 / FN-7790)
|
|
|
|
By default, selecting a `grok-cli/*` **model** for an agent/task routes through
|
|
the **direct xAI OpenAI-compatible endpoint** (`https://api.x.ai/v1`,
|
|
FN-7711/FN-7714) whenever Fusion can see a `GROK_API_KEY` (environment or
|
|
`~/.grok/user-settings.json` `apiKey`). If no Fusion-visible key resolves and
|
|
the Grok Runtime plugin is registered, Fusion automatically routes that session
|
|
through the `grok` CLI runtime instead, letting the CLI own auth end-to-end.
|
|
|
|
To route a specific agent's execution through the `grok` CLI runtime explicitly:
|
|
|
|
1. Open the agent in the dashboard (**New Agent** or an existing agent's detail view).
|
|
2. Under **Runtime Source**, choose **Runtime** instead of **Built-in Model**.
|
|
3. Select **Grok Runtime** from the runtime dropdown (sourced from `GET /api/plugins/runtimes`).
|
|
4. Save. The agent's `runtimeConfig.runtimeHint` is now `"grok"`; every session that agent drives resolves through this plugin's `GrokRuntimeAdapter` instead of the default pi runtime.
|
|
|
|
**Automatic fallback precedence (FN-7753):** explicit runtime hint > Fusion-visible key/direct endpoint > automatic CLI fallback. The fallback is only derived when no explicit runtime hint is set, the provider is `grok-cli`, no Fusion-visible key resolves, and runtime id `"grok"` is registered. The selected model is normalized from `grok-cli/<id>` (or `grok/<id>`) to `<id>` and sent as `grok agent -m <id> stdio`.
|
|
|
|
**Known limitation:** explicit Runtime-mode is still model-agnostic — it does not carry a specific `grok-cli/*` model id through to the adapter, so `GrokRuntimeAdapter.createSession()` falls back to `"grok/default"` and omits `-m`. Built-in Model selections preserve the model either through the direct endpoint (when a key is visible) or through the FN-7753 automatic CLI fallback (when no key is visible).
|
|
|
|
## Enable via Settings → Authentication
|
|
|
|
1. Install the `grok` CLI and authenticate it (`grok login` or `XAI_API_KEY`) — Fusion does not need to see the key for the CLI path.
|
|
2. Open Settings → Authentication in the Fusion dashboard.
|
|
3. The "Grok — via Grok CLI" card shows probe status. Click **Enable** once the binary is available; a non-blocking hint appears only if Fusion did not detect a key, noting the direct xAI streaming path uses `GROK_API_KEY` when present.
|
|
4. Discovered Grok models (via `grok models`) then merge into the model picker under the `grok-cli` provider id.
|
|
|
|
## Notes
|
|
|
|
Do not invent a `grok status`/`whoami` JSON auth contract — readiness is derived from binary availability, mirroring the Cursor CLI provider. See `AGENTS.md`'s "External-integration evidence" policy for why the release/checksum fields above stay at `upstream-pending-verification`.
|