The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Llm Cli Gateway listing page.
"Without consultation, plans are frustrated, but with many counselors they succeed." — Proverbs 15:22 (LSB)
Secure local control plane for AI coding agents.
llm-cli-gateway lets supported MCP clients operate Claude Code, Codex, Gemini/Antigravity, Grok Build, Mistral Vibe, Cognition Devin, Cursor Agent, and configured HTTP API providers through one user-owned gateway while preserving native CLI sessions, local credentials, durable async jobs, validation receipts, and review workflows.
Why developers try it: use the client you are already in to delegate work to local coding agents, scope remote execution to registered workspaces, gate risky actions, survive disconnects, and collect auditable review evidence without turning those agents into a generic chat proxy.
Current signals: CI and security workflows pass on main, OpenSSF Scorecard is published, OpenSSF Best Practices is passing, releases use Sigstore signing, and the package is MIT licensed.
Or use directly with npx from an MCP client:
llm-cli-gateway is a single-user MCP control plane for operating AI coding agents from supported local or remote clients. It is more than a thin CLI wrapper:
promptParts, including explicit Claude cache_control when opted in.sessionId for a gateway worktree; fresh, createNewSession, and resumeLatest-only worktree requests fail closed because they cannot durably reselect it. Materialization suppresses repository, system, and global Git hooks, configured clean, smudge, and process checkout filters, sparse checkout, and lazy object fetching. Filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands.doctor --json, setup UI artifacts, provider setup snippets, Docker fallback, and checked release bundles.workspace; every HTTP/tunnel request must use a registered alias, session workspace, or [workspaces].default before provider execution. Local unrestricted filesystem access is the stdio transport.The repo ships agent-ready workflow skills under .agents/skills for async orchestration, session continuity, multi-LLM review, implement-review-fix loops, retrospective evidence walks, secure approval-gated dispatch, and Personal Agent Config Kit operations. Nine caller-facing skills are bundled in the published npm package: async-job-orchestration, multi-llm-review, session-workflow, secure-orchestration, implement-review-fix, retrospective-walk, public-demo-session, least-cost-routing, and personal-agent-config-kit. Machine-readable DAG-TOML plans live under docs/plans and setup/install-plan.dag.toml for workflows that need deterministic sequencing and verification gates.
Skill packs can be updated outside the core npm release by placing skill
directories in local, operator-controlled paths. The gateway loads bundled
skills first, then [skills].paths, then LLM_GATEWAY_SKILLS_PATH, then
~/.llm-cli-gateway/skills when it exists; later roots override earlier skills
by name. Each skill is a directory containing SKILL.md. A root may also carry
skill-pack.json to pin expected SKILL.md hashes:
The loader is intentionally local-only: it never fetches remote Markdown at
startup. To update a pack, install or replace files through your package manager
or deployment system, then restart the gateway so the advertised skills://...
resources refresh.
The next documentation focus is provider-specific skill and DAG-TOML pairs for each outbound CLI and API-provider family: Claude, Codex, Gemini/Antigravity, Grok, Mistral Vibe, Devin, Cursor Agent, OpenAI-compatible endpoints, Anthropic Messages, and xAI Responses. The implementation plan is tracked in docs/plans/provider-workflow-assets.dag.toml, with each provider asset expected to cover install/login checks or token-env checks, session behavior, approval modes, cache/telemetry surfaces, failure modes, and a smoke-test gate.
npm-shrinkwrap.json so registry installs resolve the audited release tree. Release gates regenerate it from package-lock.json, compare for parity, and run a registry-fidelity consumer install before publishing.socket.yml and under "Security Considerations" below. shellAccess and shrinkwrap are reviewed package capabilities/configuration for this CLI appliance, not hidden install behaviour.The personal-appliance contract keeps that surface intentionally narrow: one trusted user runs the gateway on a machine or volume they own, connects one MCP endpoint, and lets supported clients operate local coding agents through workspace-scoped, approval-gated, auditable requests.
The product contract is documented in docs/personal-mcp/PRODUCT_CONTRACT.md. It defines the single-user scope, security posture, target support matrix, and provider-support verification gates. Public setup guides must not claim ChatGPT, Claude web, Claude Desktop, Codex, Gemini CLI, Gemini web, or Grok inbound support until the corresponding provider/client path has been verified.
This project does not provide hosted multi-tenant credential custody. Provider credentials stay on the user's machine or user-owned deployment volume.
For a single developer who works on several workstations and repositories, the Personal Agent Config Kit guide explains the Git-synchronised personal baseline, repository overlays, immutable context stamps, and workstation-safe provider continuity model. The baseline directory is confined to a non-symlinked descendant of the local home directory, and every publish or sync revalidates its configured origin fetch and push URLs against the HTTPS/SSH-only policy. The Kit is intentionally local-caller-only; Kit provider execution and recovery of an unadmitted attempt require healthy durable SQLite or PostgreSQL async-job admission. Kit mode supports Claude, Codex, and Mistral; every other provider fails closed while it is enabled. Kit scope never inherits the gateway process cwd: Claude and Mistral require a registered workspace selection or configured default, while Codex can also use an explicit absolute workingDir. Relative Kit workingDir values are rejected before filesystem or Git inspection. It disables cross-model validation tools while enabled and is not an HTTP/OAuth configuration or remote execution feature.
For a retention-pinned non-Kit Claude MCP request configuration, follow the local-only same-host recovery procedure. It accepts no SQL or arbitrary-path override. A valid recovery invocation emits JSON and exits 0 after success or 2 for a safe refusal; invalid usage or unavailable durable storage exits 1.
Release-readiness history is tracked in docs/personal-mcp/RELEASE_READINESS.md. Dogfooding evidence (which target LLMs guided setup, what unsafe suggestions were captured, and which findings were deferred from the initial personal-appliance rollout) is in docs/personal-mcp/DOGFOODING_RESULTS.md.
Current personal-appliance artifacts include:
LLM_GATEWAY_AUTH_TOKEN=<token> npm run start:httpnpm run doctorinstaller/ with setup, doctor --json, start, stop, status, repair, upgrade, uninstall, print-client-config, and verified bundle download commands.ubuntu-latest and builds Windows/macOS binaries on their GitHub-hosted platform runners. The private upstream uses its internal self-hosted Linux runner. Each release publishes checksummed platform bundles with the gateway, production dependencies, and a managed Node runtime; see installer/packaging/README.md.review_changes, validate_with_models, second_opinion, compare_answers, red_team_review, consensus_check, ask_model, synthesize_validation, job_status, job_result, and validation_receipt (plus the validation-receipt://{validationId} resource). review_changes and durable receipts require a SQLite or PostgreSQL validation-run store and are absent in Personal Agent Config Kit mode.Windows PowerShell:
The Windows installer keeps a stable llm-cli-gateway.exe command in
%LOCALAPPDATA%\Programs\llm-cli-gateway and adds that directory to the user
PATH. Do not script against release-versioned exe names after install.
Docker fallback:
sessionId; fresh, createNewSession, and resumeLatest-only worktree requests fail closed. A worktree requires a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default; it never inherits process cwd or combines with workingDir, addDir, or includeDirs. Materialization suppresses repository, system, and global Git hooks, configured clean, smudge, and process checkout filters, sparse checkout, and lazy object fetching. Filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands. Session deletion and TTL eviction hide a durably owned worktree session while cleanup runs. If Git removal fails, the file-backed store retains a durable cleanup-pending tombstone, blocks reuse, and retries cleanup when that store is registered on the owning host. The record is finalized only after verified Git removal.optimizePrompt / optimizeResponse, both defaulting to false. The 44% / 37% figures are v1.0.0 measurements on a specific corpus, not a guarantee: src/optimizer.ts is a deterministic phrase-stripper, and nothing measures a ratio at runtime.[persistence].backend: SQLite writes to ~/.llm-cli-gateway/logs.db by default, while PostgreSQL writes them to the configured database with the other durable subsystems. A PostgreSQL failure leaves the recorder unavailable or degraded and is reported generically on health surfaces; it never falls back to SQLite. Existing rows are not migrated or dual-read when the backend changes. Records include correlation IDs, duration, and token usage where the provider emits it (today: claude on stream-json/json, codex, and the API providers; grok, gemini, mistral, devin and cursor emit no usage on their CLI wire). Two exclusions are worth knowing: cross-LLM validation seats write no flight-recorder row at all, so llm_request_result cannot read one back by correlation ID, and repository-review seats are additionally excluded by design so review evidence is not retained in a non-expiring table. The retry_count and circuit_breaker_state columns are constants on the async path, which is the production path; retry and circuit breaking apply only to the direct-execute fallback. Read history through llm_request_list and llm_request_result so per-principal ownership checks remain in force. For human browsing of a SQLite deployment: datasette ~/.llm-cli-gateway/logs.dbstructuredContent (model, cli, correlationId, sessionId, durationMs, token counts)cache-state://global, cache-state://session/{id}, and cache-state://prefix/{hash} MCP resources return aggregate cache hit/miss/savings — tokens and hashes only, no prompt text. session_get includes a cacheState block when the session has prior requests.provider_tool_capabilities and provider-tools://catalog expose the gateway request fields, supported/degraded provider controls, local skill/tool discovery, and safe config-surface hints for Claude Code, Codex CLI, Gemini/Antigravity, Grok CLI/API, Mistral Vibe, Cognition Devin, and Cursor Agent. doctor --json includes a compact provider_capabilities summary for setup assistants.Every *_request and *_request_async tool except devin_request / devin_request_async and cursor_request / cursor_request_async accepts an optional promptParts field that structures the prompt for better cache hit rates (the Devin and Cursor headless paths take a plain prompt only). The gateway concatenates the parts in canonical order (system → tools → context → task) so that the stable prefix bytes precede the volatile task tail unchanged across calls, letting each provider's automatic prompt-caching land on the same content hash each time.
prompt and promptParts are mutually exclusive — pass exactly one.
Per-CLI capability matrix (prefix discipline is automatic via promptParts for all providers except Devin and Cursor, which have no promptParts surface; explicit levers are provider-specific):
| CLI | Prefix discipline | Explicit lever(s) |
|---|---|---|
| claude | yes | promptParts.cacheControl + outputFormat: "stream-json" (Anthropic cache_control breakpoints on stable blocks; ttl="1h" forced) |
| codex | yes | none (OpenAI implicit) |
| gemini | yes | none (implicit server-side) |
| grok | yes | compactionMode / compactionDetail (context compaction: `summary |
| mistral | yes | none (implicit) |
| devin | no | plain prompt only |
| cursor | no | plain prompt only |
Claude example (explicit cacheControl)
Gateway emits the stream-json stdin path with cache_control: {type:"ephemeral", ttl:"1h"} on marked blocks only.
Grok example (compaction)
Emits --compaction-mode segments --compaction-detail balanced.
See docs/personal-mcp/PROVIDER_CACHE_SURFACES.md for full surfaces, telemetry differences (e.g. Grok -p vs ACP), exact stream-json payload shapes, and cross-LLM review notes.
Opt-in flags (all default off) live under [cache_awareness] in ~/.llm-cli-gateway/config.toml.
*_request_async + polling tools.github/workflows/security.yml runs actionlint, zizmor, shellcheck, typos, osv-scanner, gitleaks, and lychee on every push and PR (see SECURITY.md for the threat model)Every provider is reachable through the same request, session, job, and validation machinery, but the underlying CLIs differ in what they natively expose. The table records what actually shipped per provider; discover the live surface at runtime with provider_tool_capabilities, list_models, and the provider-acp://<provider> / provider-tools://<provider> resources.
| Provider | CLI request tools | Native ACP | Live model discovery | Admin surface |
|---|---|---|---|---|
Claude Code (claude) | claude_request / _async | None (CLI-first; no ACP entrypoint at its tracked version) | model aliases, reasoning-effort levels, fallback model | read-only via provider_admin_list / provider_admin_run |
OpenAI Codex (codex) | codex_request / _async, codex_fork_session | None (codex-cli advertises mcp-server / app-server transports, not native ACP) | codex debug models | read-only via provider_admin_list / provider_admin_run |
Gemini / Antigravity (gemini, agy) | gemini_request / _async | None (agy exposes no ACP entrypoint; legacy Gemini CLI ACP evidence does not transfer) | agy models | read-only via provider_admin_list / provider_admin_run |
xAI Grok (grok) | grok_request (sync transport: "acp") / _async | Native via grok agent stdio | grok models + ~/.grok/config.toml | read-only via provider_admin_list / provider_admin_run |
Mistral Vibe (mistral) | mistral_request (sync transport: "acp") / _async | Native via vibe-acp | Vibe config plus the VIBE_ACTIVE_MODEL active model and agent profiles | read-only via provider_admin_list / provider_admin_run |
Cognition Devin (devin) | devin_request (sync transport: "acp", agentType: summarizer|review) / _async | Native via devin acp | --model / DEVIN_MODEL | read-only via provider_admin_list / provider_admin_run |
Cursor Agent (cursor) | cursor_request (sync transport: "acp") / _async | Native via cursor-agent acp (companion-owned) | model aliases | read-only via provider_admin_list / provider_admin_run |
grok, mistral, devin, and cursor expose a native ACP entrypoint, so provider-acp://<provider> carries the negotiated initialize capability set and the derived session-method availability, and the sync *_request accepts transport: "acp" (fails closed unless [acp] and the provider's runtime_enabled gate are set). ACP routing is sync-only: the *_request_async variants always run the CLI transport and do not accept transport: "acp" (nor Devin's agentType); async ACP parity is a later phase. ACP workspace selection is gateway-owned: an explicit ACP workspace must be a registered alias. A fresh remote ACP request uses that alias or [workspaces].default; a remote resume is fixed to its recorded canonical alias and cwd, and a different or unbound workspace is rejected. Local ACP may omit workspace; each unscoped process then gets a fresh private 0o700 neutral directory that is removed after the process exits, never a shared predictable temp path. claude, codex, and gemini have no native ACP entrypoint at their target CLI versions; their provider-acp:// records report native: false with no methods and no adapter-as-native masquerade, and they expose no transport: "acp" selector.approvalStrategy:"mcp_managed" is executable only by the Claude CLI adapter, which launches Claude with a request-scoped generated MCP configuration and --strict-mcp-config. It permits only provisioned, gateway-owned MCP definitions and rejects dynamic npx, ambient-PATH, and Codex-config overrides. Codex, Gemini, Grok, Mistral, Devin, and Cursor reject mcp_managed before launching a provider because their current adapters cannot isolate ambient MCP configuration. For those adapters, use approvalStrategy:"legacy"; approvalPolicy has no effect.approvalStrategy:"mcp_managed" and any approvalPolicy are rejected when transport:"acp" is selected. Use the Claude CLI transport for managed approval. ACP host services fail closed, gated by the tool-call category the agent declares: write is denied unless allow_write_host_services is set, execute unless allow_terminal_host_services is set, and any other category is denied outright, including fetch and every unrecognised kind, so a new upstream tool kind cannot be auto-approved by default. Approval is expressed only by selecting an agent-offered single-use allow option; an agent that offers only a persistent allow_always grant is denied, so ACP never maps a raw CLI bypass input to a standing permission grant. Note the boundary is this category gate: it constrains what the agent may ask the gateway to do, not what the agent does in its own process.models://<provider>, sessions://<provider>, provider-acp://<provider>, provider-tools://<provider>, and provider-subcommands://<provider>.models://<provider> and list_models, degrading to static registry facts when a live probe is unavailable (a resource read never spawns a CLI).provider_admin_list and provider_admin_run are read-only for every provider. State-mutating admin operations are exposed only through provider_admin_mutate, gated behind [admin] allow_mutating_cli_admin_ops, the remote cli:admin scope, an approval gate, and an audit record. Mutating ACP session operations are likewise gated behind [acp] allow_mutating_session_ops.review_changes, validate_with_models, second_opinion, compare_answers, red_team_review, consensus_check, ask_model, and synthesize_validation, with canonically hashed immutable receipts via validation_receipt and the validation-receipt://{validationId} resource. review_changes captures a complete, hashed Git artifact and starts repository-bound read-only reviewers.Node.js >= 24.4.0 is required (engines.node in package.json). The SQLite backend uses Node's built-in node:sqlite module, so there is no native binding to compile and no install scripts run. The 24.4 floor is where allowBareNamedParameters defaults to true, which the SQLite persistence layer relies on.
Running the source-tree release audit also requires Bash and flock from
util-linux. This prerequisite was verified against commit
242e7669565ecc7c71183f5f7133791a1384ca7c. Release automation runs the audit
on Ubuntu. On macOS, install a compatible flock before running
npm run security:audit or the full npm run check gate.
Before using this gateway, you need to install the CLI tools you want to use:
The Gemini provider runs through Google Antigravity CLI (agy).
Vibe-specific notes:
VIBE_ACTIVE_MODEL environment variable —
Vibe has no --model flag. The gateway discovers ~/.vibe/config.toml /
VIBE_MODELS, injects VIBE_ACTIVE_MODEL only when a model is explicitly
requested or Vibe config needs recovery, and retries once after a
model-not-found failure with refreshed discovery.permissionMode is the Vibe --agent name. Builtins are
default | plan | accept-edits | auto-approve; Vibe also accepts install-gated
builtins (e.g. lean) and custom agents from ~/.vibe/agents. Requests pass
the selected name through for Vibe to validate. mcp_managed is not available
for Vibe.--enabled-tools <tool> flag per allowedTools entry and one
--disabled-tools <tool> flag per disallowedTools entry. Vibe applies
disabled tools after enabled-tool filtering.~/.vibe/logs/session/session_<...>/meta.json for usage and cost.
A missing, malformed, or not-yet-known session log leaves those fields empty.cli_upgrade --cli mistral detects whether you used
pip / uv / brew and dispatches the matching upgrade command. Running
vibe update is not a thing.Or use directly with npx:
For clients that already support local stdio MCP servers, add a configuration like:
Stdio is the recommended path for unrestricted machine-local development access. HTTP MCP, including localhost HTTP and tunneled HTTPS, is treated as remote-capable for provider execution: provider tools must resolve a registered workspace alias, a session workspace, or [workspaces].default before spawning a CLI. Remote clients should pass relative workingDir, addDir, and include-directory values inside the selected workspace, and may resume only gateway-tracked sessions they own. Raw native provider session IDs are local-only. Disabling auth or using a no-auth connector path is not a filesystem bypass.
For a local CLI request with no resolved workingDir, registered workspace,
or gateway-managed worktree, the child runs in a fresh private 0o700
temporary directory that is removed after the process exits. It never inherits
the gateway repository cwd or its provider-native instruction context. The
gateway canonicalizes the temp root and rejects or relocates it when any
ancestor contains .git, AGENTS.md, AGENTS.override.md, Agents.md,
AGENT.md, CLAUDE.md, Claude.md, CLAUDE.local.md,
.claude/CLAUDE.md, .claude/rules/, .cursor/rules/, .cursorrules,
GEMINI.md, or .vibe/config.toml, including through a symlinked or custom
TMPDIR beneath that context. The list covers entries a provider discovers by
walking up from its cwd. User-scope configuration such as
~/.claude/settings.json is deliberately absent: it loads on every invocation
regardless of cwd, so relocating the workspace would not isolate it.
Provider-native resumeLatest operations that use a cwd-scoped latest-session
pointer therefore require an explicit workingDir, workspace, or configured
default workspace and fail closed when none is available. Use explicit target
selection whenever several repositories are active at once.
CLI request schemas accept prompts up to 100,000 characters, but operating
systems also impose byte limits on individual argv elements. Codex new and
resume requests stream the exact prompt over stdin. codex_fork_session
remains argv-bound and rejects an oversized UTF-8 prompt before spawn as
non-retryable input_too_large. Other providers whose current CLI contracts
require an argv prompt use the same admission rule. Every other
caller-controlled argv value is checked on its final encoded form too,
including serialized agent/schema JSON, joined tool lists, instruction
overrides, paths, model names, and native session IDs. The final spawn boundary
checks every argv element plus the aggregate resolved command line against a
conservative platform-specific byte budget and a 2,048-element cap. The
aggregate byte budget excludes the environment but reserves headroom for it;
on Windows, pre-resolution admission assumes the smaller npm .cmd/.bat
wrapper limit until command resolution proves a native executable. Native
session and resume flags on non-Kit requests are included before workspace,
session, provider-artifact handoff, or durable job side effects. Claude Kit
projects its eventual argv before materializing its compiled context artifact
or allocating a durable Kit session.
An embedded NUL byte in the command or any argv element is rejected before
spawn as non-retryable invalid_input. Caller-facing results, long-lived job
memory, durable job args, and async flight rows use a fixed invalid-argv marker;
the optional duplicate durable payload is suppressed. None retains the rejected
vector or Node's value-echoing native error.
Native E2BIG, including an environment-driven failure, is normalized without
retaining the native spawnargs. The gateway never truncates instructions or
other values to make them fit. For stdin-backed requests, a clean provider exit
is accepted only after the complete payload write callback succeeds. A closed
or still-pending pipe becomes a fixed, non-sensitive incomplete-delivery
failure; timeout, cancellation, and provider nonzero exits remain authoritative.
This generic stdio example is not provider-support verification for the Personal MCP Appliance. Client-specific setup guides for ChatGPT, Claude web, Claude Desktop, Codex, Gemini CLI, Gemini web, and Grok remain gated by the provider-support matrix in docs/personal-mcp/PRODUCT_CONTRACT.md.
The personal-appliance surface exposes simplified validation tools for non-developer clients. These tools start provider CLI jobs through the durable async job manager and return normalized provider status plus raw job references.
validate_with_models: ask two or more providers to independently validate a question.review_changes: capture one complete Git review artifact, fence repository
content as untrusted data, and start read-only independent reviewers. See
Repository change review.second_opinion: ask one provider to review an answer.red_team_review: challenge a plan, answer, or document for risks and failure modes.consensus_check: check whether providers agree with a claim.ask_model: ask one provider through the simplified surface.synthesize_validation: run an explicit judge model after provider results have
been collected. General validation requires the caller's question and terminal
normalized results. A review_changes run instead reloads its exact owned
durable results from validationId; caller-supplied question/results are ignored.list_available_models: list the models each provider CLI exposes through the simplified surface.job_status and job_result: poll and collect validation job outputs.validation_receipt: retrieve the canonically hashed immutable receipt of a terminal cross-LLM validation run by validationId (returns minted | pending | verification_failed | expired_unminted | not_found, own-or-not-found). verification_failed means a stored receipt exists but disagrees with its durable run, which is a defect to investigate; expired_unminted only ever means absence. format: "markdown" renders a human-readable report; includeRawResponses inlines complete provider answer text when the linked job still exposes identity-verified output. Registered only when the attached job store provides the durable validation-run store capability (sqlite and postgres).The same receipt is also exposed as the validation-receipt://{validationId} MCP resource (same durable gate and own-or-not-found owner scoping).
The validation report preserves per-provider disagreement. Optional judge synthesis is explicit about which provider produced the judge job.
review_changes accepts an absolute local workingDir or a registered
workspace, then resolves scope: "auto" | "uncommitted" | "branch" | "commit". It can take an explicit Git base, literal repository-relative
paths, stance: "standard" | "adversarial", reviewer models, an optional
judgeModel, trustCursorWorkspace, and fail-closed artifact/prompt byte
ceilings.
Cursor refuses to review a directory it does not trust, so a cursor seat is
granted --trust only when the reviewed directory is a registered
[[workspaces.repos]] path whose providers include cursor (a gateway worktree
beneath one counts, and the nearest enclosing registration decides). On any
other directory the cursor seat is skipped with an actionable reason, and the
rest of the roster still runs. trustCursorWorkspace: true accepts the grant
for one durable review run. The consent applies to Cursor seats in that run's
reviewer roster and to its planned Cursor judge when synthesize_validation
launches it later. It is bound to the run owner, repository, and planned judge,
so another principal or review run cannot replay it. That is a real decision
rather than a formality: a trusted folder is also where cursor loads project
rules and AGENTS.md, so the repository under review gains some influence over
its own reviewer, which the fenced review prompt otherwise forbids. The artifact keeps
committed, staged, unstaged, and regular non-ignored untracked file evidence separate. It
forces tracked diffs to remain readable even when in-tree attributes mark them
as non-diffable. The review-evidence.v2 artifact exposes committedPatch,
stagedPatch, and unstagedPatch independently; each segment carries its
sorted path inventory, encoding, exact byte length, SHA-256 identity, and
content. This prevents an index change and its worktree-only reversal from
canceling out. The artifact is collision-fenced, byte-counted, SHA-256
identified, race-checked, and never truncated. In auto mode, a diverged branch is
reviewed from its merge base with working-tree evidence included. Otherwise,
a dirty tree selects uncommitted changes, while a clean tree falls back to the
last commit (HEAD^..HEAD) without working-tree evidence. Unsafe untracked
file types or a repository mutation during capture cause a refusal.
The tool starts asynchronous provider jobs and returns a validationId, exact
artifact and prompt identities, file inventory, and one rawJobReference per
reviewer. Poll those references with validation job_status and collect them
with validation job_result, not the similarly named llm_job_* tools. If a
judge was requested, wait for every reviewer to become terminal, then call
synthesize_validation with the validationId and the same workingDir or
workspace selector. Continue collecting results for progress and human
visibility, but do not pass them as review evidence: for a review_changes run,
the gateway ignores caller-supplied question and providerResults, reloads
the exact owned durable linked terminal jobs, and reconstructs requested but
unavailable seats as skipped. General validation synthesis still requires a
caller-supplied question and terminal normalized results.
The review surface is registered only with durable SQLite or PostgreSQL job and
validation-run storage. Each CLI review job retains the exact fenced prompt in
its expiry-bound payload_json; its persisted argv contains only a hash marker.
The non-expiring flight recorder does not receive repository-review prompts.
Configured HTTP/API reviewer seats require explicit allowApiUpload:true
because the complete artifact leaves the local CLI boundary. Remote HTTP/OAuth
workspace reviews reject API reviewer uploads even with that flag. Treat the
durable job store as sensitive. Its retention is unbounded by default, and an
operator can set [persistence.retention].jobs when a bounded record is
required.
When judgeModel is an HTTP/API provider, review_changes binds that explicit
consent, the judge provider, the resolved repository, and the caller identity to
the durable validationId. The later synthesize_validation call must provide
that id and the same repository selector. The stored judge, repository, owner,
and upload consent are authoritative. The gateway atomically claims the planned
judge once, so concurrent or repeated synthesis cannot start a second judge.
A follow-up argument cannot grant or override upload consent.
claude_requestExecute a Claude Code request with optional session management.
Parameters:
prompt (string, optional*): The prompt to send (1-100,000 chars). *Exactly one of prompt or promptParts is required (mutually exclusive)model (string, optional): Model name or alias (use list_models for available values; supports latest)outputFormat (string, optional): Output format (text|json|stream-json), default: stream-json — the gateway parses NDJSON usage events for token/cost observability; override to text only when you want unparsed stdoutsessionId (string, optional): Specific session ID to use. Under mcp_managed, native continuation is a high-risk input because it can inherit an unverified provider posture; it requires approval and LLM_GATEWAY_APPROVAL_ALLOW_BYPASS=1, but does not select a full-permission profile.continueSession (boolean, optional): Continue the active session. It has the same managed-approval requirement as sessionId. Because Claude --continue selects by cwd, it requires workingDir or a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default. That workspace may optionally supply a gateway worktree. The request fails closed when no selection supplies a stable cwd.createNewSession (boolean, optional): Always create a new sessionforkSession (boolean, optional): Fork the resumed session instead of appending to it. Under mcp_managed, it is a high-risk native-fork input that requires approval and LLM_GATEWAY_APPROVAL_ALLOW_BYPASS=1, but stays bounded.allowedTools (string[], optional): Restrict Claude tools to this allow-list. A non-empty allow-list is a high-risk managed input because it can change the tool posture.disallowedTools (string[], optional): Explicitly deny listed Claude toolspermissionMode (string, optional): Claude permission mode (default|acceptEdits|plan|auto|dontAsk|bypassPermissions); preferred over dangerouslySkipPermissions. bypassPermissions is a direct full-permission request under mcp_managed.dangerouslySkipPermissions (boolean, optional): Deprecated, maps to permissionMode: "bypassPermissions"; permissionMode wins when both are set. It is a direct full-permission request under mcp_managed.agent (string, optional): Named sub-agent to run as. A non-empty value is a high-risk managed input because it can change tool and permission posture.agents (string, optional): Inline agent definitions JSON. A non-empty value is a high-risk managed input for the same reason.systemPrompt / appendSystemPrompt (string, optional): Replace or extend the system prompt. A non-empty value is a high-risk managed input.systemPromptFile / appendSystemPromptFile (string, optional): Replace or extend the system prompt from a file. A non-empty file path is a high-risk managed input.safeMode (boolean, optional): Start Claude with local customizations disabled, including CLAUDE.md, skills, plugins, hooks, MCP, commands, and agents. true is a high-risk managed input.bare (boolean, optional): Start Claude in minimal mode, skipping local customization discovery. true is a high-risk managed input.debugFile (string, optional): Write Claude debug output to a file. A non-empty path is a high-risk managed input.maxBudgetUsd (number, optional): Budget cap in USD for the requestmaxTurns (integer, optional): Agent-loop turn capeffort (string, optional): Reasoning effort (low|medium|high|xhigh|max)fallbackModel (string, optional): Auto-fallback model when the default is overloadedjsonSchema (string, optional): JSON Schema literal constraining structured outputaddDir (string[], optional): Additional workspace directories. A non-empty value is a high-risk managed input.noSessionPersistence (boolean, optional): Ephemeral session (not persisted to disk)settingSources / settings / tools (optional): Setting sources to load, settings JSON path/literal, built-in tool restriction. Non-empty setting sources, settings, or tool selections are high-risk managed inputs.pluginDir / pluginUrl (string[], optional): Load Claude plugins from local directories or URLs. Non-empty values are high-risk managed inputs.excludeDynamicSystemPromptSections (boolean, optional): Trim dynamic system prompt sectionsapprovalStrategy (string, optional): "legacy" (default) or "mcp_managed". Managed mode uses acceptEdits by default and forces strictMcpConfig:true, so Claude uses only the gateway-generated MCP configuration. A direct full-permission request requires all of an explicit caller request, an approval-manager approval, and LLM_GATEWAY_APPROVAL_ALLOW_BYPASS=1. Other high-risk inputs require the approval and operator setting too, but remain bounded and do not themselves select full permission.approvalPolicy (string, optional): "strict", "balanced", or "permissive"mcpServers (string[], optional): Names of MCP servers to expose to Claude (default: none). Legacy requests resolve names from the local registry or Codex MCP config; unknown names are reported as unavailable. Under mcp_managed, Claude uses only the generated configuration and only registry entries explicitly provisioned as gateway-owned local commands are eligible. Dynamic npx launchers, ambient-PATH commands, and Codex-config overrides are rejected. Configure and deploy the managed entries in the gateway environment.strictMcpConfig (boolean, optional): In legacy mode this defaults to false; set true to require only the generated MCP config and fail if requested servers are unavailable. Under mcp_managed, the gateway forces it to true and a caller-supplied false cannot weaken that boundary.optimizePrompt (boolean, optional): Optimize prompt for token efficiency (44% reduction), default: falseoptimizeResponse (boolean, optional): Optimize response for token efficiency (37% reduction), default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Kill a stuck process after output inactivity; 30,000 to 3,600,000 ms. Idle enforcement applies only when outputFormat is stream-json; it is ignored for text/json, which produce no output until the run completesworktree (boolean|object, optional): Run inside a gateway-owned git worktree (slice λ). A worktree requires a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default; it never inherits process cwd or combines with workingDir, addDir, or includeDirs. Materialization suppresses repository, system, and global Git hooks and configured clean, smudge, and process checkout filters, so filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands. Requesting a worktree is a high-risk managed input that requires approval and LLM_GATEWAY_APPROVAL_ALLOW_BYPASS=1, but remains bounded.promptParts (object, optional): Cache-aware structured prompt { system?, tools?, context?, task }; mutually exclusive with promptforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falseWorkspace boundary: stdio callers may use machine-local paths directly. HTTP/tunnel callers must pass workspace or rely on a configured default/session workspace; path fields are then validated relative to that workspace. [workspaces].allow_unregistered_working_dir is an inert legacy key: it is still accepted so old configs keep loading, but nothing reads it at either value, and setting it now logs a warning at startup. It never allowed arbitrary HTTP working directories or additional directories.
Response extras:
approval: Approval decision record when approvalStrategy="mcp_managed"mcpServers: Requested/enabled/missing MCP servers for this callExample:
codex_requestExecute a Codex request with optional session tracking.
Parameters:
prompt (string, optional*): The prompt to send (1-100,000 chars). *Exactly one of prompt or promptParts is required (mutually exclusive)model (string, optional): Model name or alias (use list_models for available values; supports latest, recommended: gpt-5.5)fullAuto (boolean, optional): Deprecated — expands to --sandbox workspace-write only (current Codex no longer accepts approval-policy flags); prefer sandboxModesandboxMode (string, optional): Codex sandbox (read-only|workspace-write|danger-full-access).dangerouslyBypassApprovalsAndSandbox (boolean, optional): Request Codex's full approvals-and-sandbox bypass.dangerouslyBypassHookTrust (boolean, optional): Request Codex hook-trust bypass.approvalStrategy (string, optional): "legacy" is the only executable strategy. "mcp_managed" is rejected before Codex launches because the adapter cannot isolate ambient MCP configuration.approvalPolicy (string, optional): Has no effect for Codex because mcp_managed is unavailable.mcpServers (string[], optional): Metadata only. It does not configure or isolate Codex MCP servers.sessionId (string, optional): Session identifier for tracking.resumeLatest (boolean, optional): Resume a previous Codex session (codex exec resume --last). Do not rely on which session --last selects or on the resumed working directory (#258): --last is cwd-filtered upstream and the child is still spawned with the gateway-resolved cwd. Verify the target, or start a fresh session when it must be certain. Ignored if sessionId is set.createNewSession (boolean, optional): Always create a new sessionforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falseoutputFormat (string, optional): text (default) or json (--json JSONL events for token usage extraction)outputSchema (string|object, optional): Codex --output-schema, path or inline JSON Schema.workingDir (string, optional): Working root for this session (-C/--cd; new sessions only). Personal Agent Config Kit mode requires an absolute path.addDir (string[], optional): Additional writable workspace directories (one --add-dir per entry; new sessions only).ephemeral (boolean, optional): Codex --ephemeral (no session persistence)images (string[], optional): Image attachments (one -i <path> per entry).profile (string, optional): Codex --profile <name> (new sessions only; ignored with a logged warning on resume).configOverrides (object, optional): Codex -c key=value overrides. Local callers only; remote HTTP/OAuth requests are rejected.enable / disable (string[], optional): Codex --enable / --disable feature overrides. They are -c features.* equivalents and are also local-only.ignoreRules / ignoreUserConfig (boolean, optional): Codex --ignore-rules / --ignore-user-config.outputLastMessage (string, optional): Codex --output-last-message <path>.oss (boolean, optional): Codex --oss, selecting the open-source provider.localProvider (string, optional): Codex --local-provider <name>.worktree (boolean|object, optional): Run inside a gateway-owned git worktree (slice λ). A worktree requires a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default; it never inherits process cwd or combines with workingDir, addDir, or includeDirs. Materialization suppresses repository, system, and global Git hooks and configured clean, smudge, and process checkout filters, so filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands.promptParts (object, optional): Cache-aware structured prompt { system?, tools?, context?, task }; mutually exclusive with promptoptimizePrompt (boolean, optional): Optimize prompt for token efficiency, default: falseoptimizeResponse (boolean, optional): Optimize response for token efficiency, default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Kill a stuck Codex process after output inactivity; 30,000 to 3,600,000 msResponse extras:
mcpServers: Requested MCP-server metadata for this callExample:
codex_fork_sessionFork an existing Codex session into a new branch (codex fork <SESSION_ID|--last> <prompt>), preserving the original session's history while the fork diverges. Unlike Codex new and resume requests, this command remains argv-bound and rejects oversized UTF-8 prompts as non-retryable input_too_large.
Parameters:
prompt (string, required): Prompt text for the forked session (1-100,000 chars)sessionId (string, optional): Codex session UUID to fork from (mutually exclusive with forkLast).forkLast (boolean, optional): Fork the most recent Codex session instead of naming one.model (string, optional): Model name or alias (e.g. gpt-5.5, latest)sandboxMode (string, optional): Codex sandbox (read-only|workspace-write|danger-full-access).approvalStrategy (string, optional): "legacy" is the only executable strategy. "mcp_managed" is rejected before Codex launches because the adapter cannot isolate ambient MCP configuration.approvalPolicy (string, optional): Has no effect for Codex because mcp_managed is unavailable.correlationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (number, optional): Idle timeout in ms (30s-1h, omit for CLI default)gemini_requestExecute a Google Antigravity CLI (agy) request with session support.
Parameters:
prompt (string, optional*): The prompt to send (1-100,000 chars). *Exactly one of prompt or promptParts is required (mutually exclusive)model (string, optional): Model name or alias (use list_models for available values; supports latest, pro, flash)sessionId (string, optional): Session ID to resume.resumeLatest (boolean, optional): Resume the latest session automatically.createNewSession (boolean, optional): Always create a new sessionapprovalMode (string, optional): Antigravity approval mode in legacy mode: default leaves agy prompted, auto_edit emits --mode accept-edits, plan emits --mode plan, and yolo emits --dangerously-skip-permissions.approvalStrategy (string, optional): "legacy" is the only executable strategy. "mcp_managed" is rejected before Antigravity launches because the adapter cannot isolate ambient MCP configuration.approvalPolicy (string, optional): Has no effect for Antigravity because mcp_managed is unavailable.includeDirs (string[], optional): Additional workspace directories (passed as --add-dir).project (string, optional): Select the Antigravity project for this session (--project <ID>); mutually exclusive with newProject.newProject (boolean, optional): Create a new Antigravity project for this session (--new-project); mutually exclusive with project.sandbox (boolean, optional): Run Antigravity in sandbox mode (--sandbox)workingDir (string, optional): Local Antigravity process working directory.
Stdio/local callers may pass local paths directly; remote HTTP/OAuth callers
must use relative paths inside a selected registered workspace. includeDirs
adds read paths but does not select cwd.workspace (string, optional): Registered gateway workspace alias that selects
the Antigravity process cwd for remote HTTP/OAuth callers.outputFormat (string, optional): text (default), json, or stream-json. The async job recorder launches the transcript-capable stream-json wire independently of the requested presentation.mcpServers (string[], optional): Metadata only. Antigravity manages its own MCP configuration; this field does not create an allowlist.allowedTools, policyFiles, adminPolicyFiles, attachments (string[], optional) and skipTrust (boolean, optional): Unsupported by Antigravity CLI. Non-empty values, or skipTrust: true, are rejected with an explanatory error.yolo (boolean, optional): Auto-approve all; equivalent to approvalMode: "yolo". Emits --dangerously-skip-permissions in legacy mode.worktree (boolean|object, optional): Run inside a gateway-owned git worktree (slice λ). A worktree requires a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default; it never inherits process cwd or combines with workingDir, addDir, or includeDirs. Materialization suppresses repository, system, and global Git hooks and configured clean, smudge, and process checkout filters, so filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands.promptParts (object, optional): Cache-aware structured prompt { system?, tools?, context?, task }; mutually exclusive with promptoptimizePrompt (boolean, optional): Optimize prompt for token efficiency, default: falseoptimizeResponse (boolean, optional): Optimize response for token efficiency, default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Total-runtime bound, not an idle timer: this provider emits no output until it exits, so the process is killed after this duration even while healthy. 30,000 to 3,600,000 ms, default 3,600,000 msforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falseResponse extras:
mcpServers: Requested MCP-server metadata for this callExample:
grok_requestExecute a Grok CLI (xAI) request with session support.
Parameters:
prompt (string, optional*): The prompt to send (1-100,000 chars). *Exactly one of prompt or promptParts is required (mutually exclusive)model (string, optional): Model name or alias (e.g. grok-4.6, grok-4.5). Prefer live discovery via list_models or models://grok: the legacy grok-build id was removed upstream and now hard-fails with Invalid params: "unknown model id".transport (string, optional): "cli" (default) runs the Grok CLI; "acp" routes through Grok's native grok agent stdio transport when [acp].enabled and the provider's runtime_enabled are set (fails closed otherwise). Both transports reject approvalStrategy:"mcp_managed"; approvalPolicy has no effect. Sync-only: grok_request_async always runs the CLI transport and does not accept transportoutputFormat (string, optional): "plain" (default), "json", or "streaming-json"sessionId (string, optional): Session ID to resume (--resume <id>).resumeLatest (boolean, optional): Resume the most recent session in the current cwd (--continue).createNewSession (boolean, optional): Always create a new sessionalwaysApprove (boolean, optional): Auto-approve all tool executions (--always-approve) in legacy mode.permissionMode (string, optional): default|acceptEdits|auto|dontAsk|bypassPermissions|plan.effort (string, optional): low|medium|high|xhigh|maxreasoningEffort (string, optional): Reasoning effort for reasoning modelsapprovalStrategy (string, optional): "legacy" is the only executable strategy. "mcp_managed" is rejected before Grok launches because the adapter cannot isolate ambient MCP configuration.approvalPolicy (string, optional): Has no effect for Grok because mcp_managed is unavailable.mcpServers (string[], optional): Metadata only. Grok manages its own MCP configuration via grok mcp; this field does not create an allowlist.allowedTools (string[], optional): Allowed built-in tools (passed as --tools comma list).disallowedTools (string[], optional): Disallowed built-in tools (passed as --disallowed-tools comma list)maxTurns (integer, optional): Agent-loop iteration cap (--max-turns)workingDir (string, optional): Working directory for this invocation (--cwd)sandbox (string, optional): Sandbox profile for filesystem/network access (--sandbox, freeform; also via GROK_SANDBOX).rules (string, optional): Extra rules appended to the system prompt (--rules; supports @file prefix).systemPromptOverride (string, optional): Replace the agent's system prompt entirely.allow / deny (string[], optional): Permission allow/deny rules (one --allow/--deny per entry).compactionMode (string, optional): summary (default) |transcript|segmentscompactionDetail (string, optional): none|minimal|balanced|verbose (segments mode only)agent (string, optional): Agent name or definition file path.agents (string|object, optional): Inline subagent definitions JSON.disableWebSearch (boolean, optional): Disable web search and remote retrieval toolstodoGate (boolean, optional): Enable runtime turn-end TodoGate (session-scoped)verbatim (boolean, optional): Send the prompt exactly as given (also skips gateway prompt optimisation)promptFile / promptJson / single (optional): Single-turn prompt from a file / JSON blocks / literal.experimentalMemory / noMemory (boolean, optional): Enable/disable cross-session memory.noAltScreen / noPlan / noSubagents (boolean, optional): Disable alt screen / plan mode / subagent spawningoauth (boolean, optional): Use OAuth during authentication.restoreCode (boolean, optional): Check out the original session commit when resuming.leaderSocket (string, optional): Custom leader socket path (--leader-socket, Grok 0.2.32+; default ~/.grok/leader.sock) targeting an isolated leader process, for example a local or branch Grok build.nativeWorktree (boolean|string, optional): Grok's own --worktree flag (true means bare, string means named); distinct from the gateway worktree option.worktreeRef (string, optional): Branch/tag/commit to base the native worktree on (--worktree-ref); requires nativeWorktree.forkSession (boolean, optional): Fork the resumed session into a new branch instead of appending to it.jsonSchema (string|object, optional): JSON Schema (string or object) constraining structured output (--json-schema)worktree (boolean|object, optional): Run inside a gateway-owned git worktree (slice λ). Grok requires an explicit provider-native sessionId; fresh, createNewSession, and resumeLatest-only worktree requests are rejected because they cannot durably reselect the worktree. A worktree requires a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default; it never inherits process cwd or combines with workingDir, addDir, or includeDirs. Materialization suppresses repository, system, and global Git hooks and configured clean, smudge, and process checkout filters, so filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands.promptParts (object, optional): Cache-aware structured prompt { system?, tools?, context?, task }; mutually exclusive with promptoptimizePrompt (boolean, optional): Optimize prompt for token efficiency, default: falseoptimizeResponse (boolean, optional): Optimize response for token efficiency, default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Kill a stuck process after output inactivity; 30,000 to 3,600,000 msforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falseExample:
Every async job is persisted to a job store as it transitions through running → completed/failed/canceled. This makes the gateway a durable collection layer:
*_request / *_request_async calls within the dedup window (default 1 hour) short-circuit onto the existing running or completed job — the caller gets back the same job ID instead of starting a duplicate run. This directly fixes the "agent times out polling, re-issues, and the whole job starts over" failure mode.llm_job_status and llm_job_result work across gateway restarts. Job rows are retained until an operator configures a bound; callers can collect results long after the in-memory cache has evicted them.orphaned only when its owning gateway instance is provably gone, never because another instance restarted. Each instance holds a periodic heartbeat lease and stamps every job it owns; the recovery sweep orphans a queued/running job only when that job's own lease has expired. On a shared store (backend = "postgres") this means a fresh instance never orphans another live instance's in-flight jobs. The captured partial output of a genuinely orphaned job remains readable, and a stale-then-reviving owner that later finishes self-heals to the correct terminal state (issue #139).forceRefresh: true on any request tool to bypass dedup and force a fresh CLI run.The durable backend is configured by ~/.llm-cli-gateway/config.toml (override with LLM_GATEWAY_CONFIG=/path/to/config.toml). Example:
Backends:
sqlite (default) — durable, file-backed. Safe for single-instance deployments.postgres: PostgreSQL is authoritative for every backend-governed durable subsystem, including async jobs, dedup, orphan recovery, HTTP jobs, validation state, session metadata, and the flight recorder. File-backed operator records such as approvals, admin audit, and the workspace registry are not SQLite/PostgreSQL engine choices. Use this for multi-instance or service deployments. Requires the optional peer dependency pg to be installed alongside the gateway.memory — in-process Map. Lost on gateway exit. Requires acknowledgeEphemeral = true to be loaded. Suitable for tests and ephemeral CI gateways.none — no store. *_request_async, llm_job_status, llm_job_result, and llm_job_cancel are NOT registered on the gateway. This is a structural invariant: agents that try to call async tools against a gateway with backend = "none" get a clean "tool not found" at connect time instead of silent in-memory loss after the 1-hour TTL. Use llm_process_health to inspect the resolved persistence state programmatically.backend = "postgres" is the whole engine decision. The configured dsn must be a PostgreSQL URL. The gateway does not infer deployment topology, resolve the host, restrict PostgreSQL to a local target, or render a DSN-derived target on diagnostics. If migration, connection, or an operation fails, the affected PostgreSQL subsystem fails closed and the gateway does not open SQLite as a fallback. Health surfaces identify the selected engine and report PostgreSQL failures generically.
Changing engines does not move data. Existing SQLite and PostgreSQL rows stay where they are: there is no automatic migration, dual-write, or cross-engine read. Plan and execute any data move separately before cutover if old history must remain available through the gateway.
backend = "none" and LLM_GATEWAY_LOGS_DB=none are different switches. The first disables async job persistence; the second disables request history. Setting the backend to "none" leaves the flight recorder writing, and disabling the recorder leaves the job store alone. Both are stated at startup in the Storage: block on stderr. llm_process_health reports the selected engine, recorder state, role configuration, and deprecated-input decisions without rendering the configured PostgreSQL target.
DATABASE_URL is deprecated and never overrides [persistence]. When it is the only selector, it acts as a deprecated alias for backend = "postgres" plus dsn, so sessions, jobs, validation state, and request history stay on one engine. Against an explicit backend, or against a dsn it disagrees with, it is ignored with a reason: the gateway does not abort, because the outcome is fully determined and is the one the config file describes.
For PostgreSQL, apply the schema with a schema-owner or dedicated migration role before starting a DML-only gateway role:
The runner serializes migration work with an advisory lock and records a SHA-256
of each migration in schema_migrations.checksum_sha256. On later runs, a
malformed or mismatched recorded checksum stops the runner before it calculates
or applies pending migrations. A NULL checksum is an explicit legacy row from
before checksum recording. It is allowed with a warning but is never backfilled,
because current source files cannot prove what SQL ran historically. Do not edit
released migration files or populate ledger checksums manually. The runner
preserves the historical 002/003 SQL and applies compatibility only while one
of those legacy versions remains pending; forward migration 018 repairs an
already-recorded legacy session/view layout. Release checks reject a source edit
to a published migration file.
Legacy environment variables (deprecated; emit a warning at startup):
LLM_GATEWAY_LOGS_DB / LLM_GATEWAY_JOBS_DB: when no backend is explicitly configured, none selects backend = "none" and any other value selects backend = "sqlite" with that path. An explicit [persistence].backend wins. LLM_GATEWAY_LOGS_DB still independently disables the recorder on every backend and paths it when the selected recorder engine is SQLite.LLM_GATEWAY_JOB_RETENTION_DAYS — overrides retentionDays.LLM_GATEWAY_DEDUP_WINDOW_MS — overrides dedupWindowMs.LLM_GATEWAY_ACKNOWLEDGE_EPHEMERAL — 1/true/yes sets acknowledgeEphemeral = true.[http] and [limits])The gateway bounds HTTP session growth and async/sync job execution so a burst of
clients or requests cannot drive unbounded memory, process, CPU, or provider-request
growth. All keys live in the same ~/.llm-cli-gateway/config.toml; defaults are
conservative but chosen not to surprise local stdio development.
Failure modes (all deterministic and safe to retry):
429 with Retry-After: 5 and a structured { error, code: "session_capacity", retryable: true } body. No new session is created.session_idle_ttl_ms, independent of the client sending DELETE. A session with an in-flight request is never reaped mid-request.*_request / *_request_async and the direct-sync fallback return a retryable saturated error (structuredContent.errorCategory = "saturated", retryable: true). Nothing is spawned. When the queue has room the job waits (FIFO, per-provider fair) up to queue_timeout_ms, then fails with the same category.SYNC_DEADLINE_MS=0 and storeless/backend="none" paths acquire the same process permit before spawning, so no execution bypasses the limiter.max_job_output_bytes is failed (exit code 126), its process terminated, its completion persisted, and its run slot released.completed_job_memory_ttl_ms only ages finished jobs out of the in-memory map. The durable job store is unbounded by default and can be bounded with [persistence.retention].jobs or the legacy [persistence].retentionDays, so results stay readable via llm_job_result / llm_request_result after in-memory eviction.Live counters are exposed on GET /healthz (unauthenticated, HTTP transport) and via the llm_process_health tool backpressure block: session current/max/oldest-age/idle-TTL/saturation, running and queued job counts globally and per provider, limiter saturation counters, configured TTL/output caps, and parent-process RSS/heap. These surfaces report counts, ages, and bytes only, never prompt text, response content, tokens, session IDs, bearer/OAuth tokens, API keys, or machine secrets.
For production user services, pair the in-process limits above with systemd's outer guardrails so an unexpected bug, provider CLI leak, or evaluation burst cannot consume the host:
Choose values for your workload: MemoryMax should cover the gateway process,
the configured max_running_jobs provider children, and normal output buffering;
TasksMax should exceed the process/thread count implied by max_running_jobs
plus the HTTP server and SQLite work, but still be far below host exhaustion. If
systemd terminates the service at those limits, durable jobs can be inspected
after restart and llm_process_health.backpressure should be used to tune
[http], [limits], MemoryMax, and TasksMax together.
By default, gateway state is global per user, not per project. With no overrides, every Claude Code window across every repo spawns its own gateway subprocess but they all read and write the same state:
~/.llm-cli-gateway/logs.db when [persistence].backend = "sqlite" (async jobs + flight recorder). With backend = "postgres", those rows live in the configured database instead. All destructive retention bounds default to OFF. [persistence.retention].jobs prunes complete job records, [persistence.retention].requests prunes the flight recorder's requests and gateway_metadata tables, and [persistence.retention].wedgedValidationRuns prunes validation runs that can never be finalized with their validation_run_jobs links. An operator must opt in to each bound. validation_receipts is immutable by design and is never pruned; a finalized run is never pruned either, so no receipt is ever orphaned.
Deleting rows frees SQLite pages but never bytes, so the file does not shrink. llm-cli-gateway storage compact --yes returns the space, with the gateway stopped, because a VACUUM holds an exclusive lock for the length of a full rewrite. doctor --json -> .storage.retention reports the resolved bounds, what a sweep would delete, and how many bytes a compaction would return. See docs/plans/durable-state-lifecycle.dag.toml.
~/.llm-cli-gateway/sessions.json (gateway session metadata when using the default file session backend)
~/.llm-cli-gateway/config.toml (resolved config)
When [persistence].backend = "postgres" selects the PostgreSQL session manager, the session metadata lives in PostgreSQL instead of sessions.json. This is usually what you want: session_list from repo A can show sessions from repo B, an async job started in window A can be polled from window B, and the 1-hour dedup window catches re-issues across windows. Gateway-managed worktrees are the exception: they are filesystem-local and therefore fail closed with PostgreSQL session storage. SQLite WAL mode protects the default job/flight-recorder database, while the file session manager uses locked atomic writes.
If unrelated repositories should not share async jobs, flight-recorder rows, or deduplication, point each project at its own persistence config. In .claude/settings.local.json for the project:
…and put a per-project config.toml in the repo:
Now every gateway subprocess spawned for this repo's Claude Code window reads its own config and writes its durable jobs, flight-recorder rows, and deduplication state to its own SQLite file. Other repos keep using the global default. This [persistence] override does not move the default file-backed sessions.json, so it does not isolate session lists. llm_process_health.persistence.sources.configFile lets an agent confirm which persistence config it is actually running under.
If you want an LLM agent to perform this setup deterministically — rather than reading the prose above and guessing — copy the following DAG-TOML into the repo (e.g. docs/planning/per-project-gateway-isolation.toml) and point your agent at it. The schema is agent-assurance template_kind = "implementation-dag". The agent MUST execute units in layer order, must not skip the verification unit, and must treat any failed gate as blocking.
Why this matters for agents: the gateway has multiple configuration surfaces (TOML file, env-var overrides, two different MCP settings files) and one easy mistake, editing the committed .mcp.json instead of the local-only .claude/settings.local.json, will silently break the per-project persistence scope for every other developer on the repo. The DAG above encodes the correct sequence, the verification gate, and the failure modes explicitly so an agent can execute it without inference. It deliberately does not claim to isolate the default file-backed session store.
mistral_requestRun a Mistral Vibe agentic coding request. Like grok_request in shape, but with Vibe's specific surface:
model (string, optional): Vibe model alias (for example mistral-medium-3.5 or latest). The resolved value is injected via the VIBE_ACTIVE_MODEL environment variable; omit it to let the gateway discover Vibe config and avoid stale hardcoded defaults.transport (string, optional): "cli" (default) runs the Vibe CLI; "acp" routes through Vibe's native vibe-acp transport when [acp].enabled and the provider's runtime_enabled are set (fails closed otherwise). Both transports reject approvalStrategy:"mcp_managed"; approvalPolicy has no effect. Sync-only: mistral_request_async always runs the CLI transport and does not accept transportpermissionMode: the Vibe --agent name: builtins default | plan | accept-edits | auto-approve, or any install-gated/custom agent. Requests emit the supplied name in legacy mode.allowedTools (string[], optional): One --enabled-tools <tool> flag per entry.disallowedTools (string[], optional): One --disabled-tools <tool> flag per entry, applied after the enabled-tool filter.outputFormat (string, optional): Vibe 2.x values are "text", "json", or "streaming"; legacy aliases "plain" and "stream-json" are accepted and normalized before spawn.sessionId / resumeLatest / createNewSession: standard session controls. Current Vibe defaults session logging to enabled; if an older config has [session_logging] enabled = false, doctor --json surfaces an actionable next-action.trust (boolean, optional): Emit --trust so Vibe trusts the cwd for this invocation only (not persisted; skips the interactive trust prompt).maxTurns (integer, optional): Agent-loop iteration cap (--max-turns, programmatic mode only)maxPrice (number, optional): Interrupt when cumulative cost crosses this USD cap (--max-price, programmatic mode only)maxTokens (integer, optional): Cap cumulative prompt + completion tokens (--max-tokens, programmatic mode only)workingDir (string, optional): Change to this directory before running (--workdir)addDir (string[], optional): Additional writable workspace directories (one --add-dir per entry).approvalStrategy (string, optional): "legacy" is the only executable strategy. "mcp_managed" is rejected before Vibe launches because the adapter cannot isolate ambient MCP configuration.approvalPolicy (string, optional): Has no effect for Vibe because mcp_managed is unavailable.mcpServers (string[], optional): Metadata only. Vibe reads its MCP configuration from VIBE_HOME config; this field does not create an allowlist.worktree (boolean|object, optional): Run inside a gateway-owned git worktree (slice λ). Mistral requires an explicit provider-native sessionId; fresh, createNewSession, and resumeLatest-only worktree requests are rejected because they cannot durably reselect the worktree. A worktree requires a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default; it never inherits process cwd or combines with workingDir, addDir, or includeDirs. Materialization suppresses repository, system, and global Git hooks and configured clean, smudge, and process checkout filters, so filter-dependent content such as Git LFS remains in its repository representation instead of executing host commands.promptParts (object, optional): Cache-aware structured prompt { system?, tools?, context?, task }; mutually exclusive with promptoptimizePrompt / optimizeResponse (boolean, optional): Token-efficiency optimisation, default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Total-runtime bound, not an idle timer: this provider emits no output until it exits, so the process is killed after this duration even while healthy. 30,000 to 3,600,000 ms, default 3,600,000 msforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falsedevin_requestRun a Cognition Devin CLI request synchronously (headless print mode, devin -p). Auto-defers to a pollable job past the sync deadline when async jobs are enabled.
Parameters:
prompt (string, optional*): Prompt text for Devin CLI (1-100,000 chars). Required in practice; promptFile is additivemodel (string, optional): Model name or alias (e.g. opus, latest)transport (string, optional): "cli" (default) runs the Devin CLI; "acp" routes through Devin's native devin acp transport when [acp].enabled and the provider's runtime_enabled are set (fails closed otherwise). Both transports reject approvalStrategy:"mcp_managed"; approvalPolicy has no effect. Sync-only: devin_request_async always runs the CLI transport and accepts neither transport nor agentTypeagentType (string, optional): ACP agent variant for transport: "acp" (devin acp --agent-type): "summarizer" (no tools, text summary) or "review" (read-only plus shell code-review); ignored for the CLI transportpermissionMode (string, optional): Devin CLI permission mode (--permission-mode): auto (auto-approves read-only tools), accept-edits (also auto-approves workspace edits), smart (also auto-runs actions a fast model judges safe), dangerous (auto-approves all). Omit to use Devin's headless defaultapprovalStrategy (string, optional): "legacy" is the only executable strategy. "mcp_managed" is rejected before Devin launches because the adapter cannot isolate ambient MCP configuration.approvalPolicy (string, optional): Has no effect for Devin because mcp_managed is unavailable.promptFile (string, optional): Load the initial prompt from a file (--prompt-file)sessionId (string, optional): Devin session ID to resume (--resume <id>). The gw-* id minted for a brand-new session is not resumable via sessionId; continue with resumeLatest: trueresumeLatest (boolean, optional): Resume the most recent Devin session in
the selected cwd (--continue). Requires workingDir, workspace, or a
configured default workspace.createNewSession (boolean, optional): Force a new sessionworkingDir (string, optional): Local Devin process cwd. CLI transport only.workspace (string, optional): Registered gateway workspace alias that
selects the Devin process cwd.worktree (boolean|object, optional): Run the Devin CLI request inside a
gateway-owned Git worktree. Devin requires an explicit provider-native
sessionId; fresh, createNewSession, and resumeLatest-only worktree
requests are rejected because they cannot durably reselect the worktree. A
worktree requires a registered workspace
selected explicitly, through caller-owned session metadata, or by the
configured default; it never inherits process cwd or combines with
workingDir, addDir, or includeDirs. Materialization suppresses
repository, system, and global Git hooks and configured clean, smudge, and
process checkout filters, so filter-dependent content such as Git LFS remains
in its repository representation instead of executing host commands.optimizePrompt / optimizeResponse (boolean, optional): Token-efficiency optimisation, default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Total-runtime bound, not an idle timer: this provider emits no output until it exits, so the process is killed after this duration even while healthy. 30,000 to 3,600,000 ms, default 3,600,000 msforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falsecursor_requestRun a Cursor Agent request synchronously. The default CLI transport uses headless print mode (cursor-agent --print) and auto-defers to a pollable job past the sync deadline when async jobs are enabled. Set transport: "acp" to use Cursor's native cursor-agent acp transport when [acp].enabled, [acp.providers.cursor].enabled, and [acp.providers.cursor].runtime_enabled are enabled. ACP accepts prompt, model, a gateway-owned ACP sessionId, and a registered gateway workspace alias. Both Cursor transports reject approvalStrategy:"mcp_managed"; approvalPolicy has no effect on CLI and is rejected on ACP.
Parameters:
prompt (string, required): Prompt text for Cursor Agent CLI (1-100,000 chars)model (string, optional): Model name or alias (for example gpt-5, sonnet-4-thinking, or latest)mode (string, optional): Cursor mode, "plan" or "ask" (--mode)outputFormat (string, optional): "text" (default), "json", or "stream-json"transport (string, optional): "cli" (default) or "acp"; ACP fails closed unless its global and Cursor provider gates are enabled. ACP accepts only prompt, model, sessionId, and a registered workspace; non-default Cursor CLI controls (mode, non-text outputFormat, workingDir, non-empty addDir, force, autoReview, sandbox, trust, resumeLatest, createNewSession, optimization or compression, idleTimeoutMs, and forceRefresh) are rejected. Sync-only: cursor_request_async always runs the CLI transport and does not accept transportforce (boolean, optional): Emit --force for non-interactive operation.autoReview (boolean, optional): Emit --auto-review.sandbox (string, optional): "enabled" or "disabled" (--sandbox).trust (boolean, optional): Emit --trust for this invocation.workspace (string, optional): On transport: "cli", a Cursor workspace path or name (--workspace); remote HTTP/OAuth callers must pass a registered workspace alias, while local stdio callers may pass paths. An unregistered relative local value is preserved verbatim as a provider-native saved-workspace name and is never resolved against the gateway process cwd; pass an absolute path to select a local directory cwd. On transport: "acp", it must be a registered gateway workspace alias. A fresh remote ACP request uses the supplied alias or [workspaces].default; a remote ACP resume stays bound to its recorded canonical alias and cwdworkingDir (string, optional): Local Cursor Agent process working directory, CLI transport only. Distinct from workspace, which is Cursor's own selector; passing an absolute workspace path that disagrees with workingDir is rejected rather than silently ranked. Rejected on transport: "acp", which resolves its own scope, rather than being accepted and discarded.addDir (string[], optional): Additional workspace roots (one --add-dir per entry); remote HTTP/OAuth callers must use registered workspace roots.sessionId (string, optional): On transport: "cli", a Cursor chat/session ID to resume (--resume <id>). The gw-* id minted for a brand-new gateway session is not resumable through the CLI transport; continue with resumeLatest: true. On transport: "acp", pass the gateway-owned ACP session ID returned by an earlier ACP call; Cursor-native and CLI session IDs are rejectedresumeLatest (boolean, optional): CLI only: resume the most recent Cursor chat (--continue). true is rejected on ACP.createNewSession (boolean, optional): CLI only: force a new session. true is rejected on ACP.approvalStrategy (string, optional): "legacy" is the only executable CLI strategy. "mcp_managed" is rejected before Cursor launches; ACP has its own permission bridge and also rejects it.approvalPolicy (string, optional): Has no effect on CLI because mcp_managed is unavailable. ACP rejects it because ACP uses its own permission bridge.optimizePrompt / optimizeResponse (boolean, optional): Token-efficiency optimisation, default: falsecorrelationId (string, optional): Request trace ID (auto-generated if omitted)idleTimeoutMs (integer, optional): Total-runtime bound, not an idle timer: this provider emits no output until it exits, so the process is killed after this duration even while healthy. 30,000 to 3,600,000 ms, default 3,600,000 ms. This holds for the default text invocation; with outputFormat: "stream-json" Cursor streams incrementally, so the same timer behaves as a genuine idle windowforceRefresh (boolean, optional): Bypass dedup and force a fresh CLI run, default: falseclaude_request_async / codex_request_async / gemini_request_async / grok_request_async / mistral_request_async / devin_request_async / cursor_request_asyncStart a long-running Claude, Codex, Gemini, Grok, Mistral, Devin, or Cursor request without waiting for completion in the same MCP call.
Use this flow when analysis/runtime can exceed client tool-call limits:
*_request_asyncllm_job_statusllm_job_resultllm_job_cancelAsync request tools accept the same strategy fields as their sync variants:
claude_request_async supports approvalStrategy:"legacy" (default) or "mcp_managed", and approvalPolicy:"strict"|"balanced"|"permissive". Managed mode forces strictMcpConfig:true and launches Claude with only the generated MCP config.*_request_async tool supports only executable approvalStrategy:"legacy". It rejects mcp_managed before provider launch because ambient MCP configuration cannot be isolated; approvalPolicy has no effect.mcpServers configures the Claude generated config only. For the other CLI adapters it is metadata only and does not create an MCP allowlist.llm_job_statusReturn lifecycle status (queued, running, completed, failed, canceled,
orphaned), metadata, and bounded normalized progress for an async job.
afterProgressSeq returns events with a greater sequence number and
progressLimit selects up to 64 events in forward sequence order. Continue with
nextAfterSeq; highWaterSeq (and its compatibility alias lastSeq) reports
the highest sequence observed for the job, while hasMore reports whether
another retained page is immediately available. The progress snapshot reports
capability (structured, activity_only, or lifecycle_only),
lastActivityAt, cursor/high-water metadata, droppedCount, and events with a phase, kind,
timestamp, safe message, and source. Claude stream-JSON, Codex JSONL, Grok
streaming-JSON, Gemini stream-JSON, Mistral streaming, and Cursor stream-JSON
expose structured activity. Codex validation and repository
review calls do not request JSONL and therefore report activity_only. HTTP/API
jobs report lifecycle_only; other process output modes expose only privacy-safe
activity/lifecycle signals. Raw reasoning, provider-supplied tool names, tool
arguments, paths, provider IDs, and output text are not copied into progress
messages. Tool-start activity uses the fixed message Using a provider tool.
llm_job_watchWait up to 30 seconds for new normalized progress on an owned async job. Pass
the response's nextAfterSeq as afterProgressSeq; the response uses the same
snapshot shape as llm_job_status. When the MCP request carries a progress
token, the gateway emits notifications/progress only while that watch call is
active. The tool rechecks owner access throughout the wait and returns the same
own-or-not-found result as other job tools.
llm_job_resultReturn captured stdout/stderr for an async job. By default it returns a
display-oriented result, with maxChars limiting each stdout and stderr stream
to 1,000 through 2,000,000 characters per call (200,000 by default).
For complete, resumable retrieval of a large provider stream, set
rawOutput:true. The response's result includes independent
stdoutOffsetChars, stdoutTotalChars, and stdoutNextOffsetChars fields,
plus matching stderr* fields. Start both offsets at zero, then pass each
non-null next offset back as stdoutOffsetChars or stderrOffsetChars until
that stream's next offset is null. Raw pages are not display-parsed or
compressed. On the local stdio surface, pages concatenate in stream order to
the captured stdout or stderr stream. Remote callers use the same offset
protocol, but provider-session-ID ranges are redacted before pages are
returned, including an ID that crosses a page boundary. Treat remote
rawOutput:true as resumable, sanitized output, not byte-for-byte captured
provider output.
Non-zero offsets are rejected in default display mode. Display mode can parse a
streaming provider format, reconstruct a Codex reply, or compress text, so a
slice of the captured stream cannot safely resume or concatenate the displayed
result. Use rawOutput:true whenever an application must resume output
collection.
Every non-Kit CLI job records the exact launched argv, the resolved cwd scope, the repository HEAD when available, bounded SHA-256 instruction-file evidence, the capture grammar, and whether the transcript was captured whole, captured to the stated 50 MiB aggregate ceiling, or not captured. Claude, Codex, Gemini, Grok, Mistral, and Cursor are launched with their richest transcript-capable wires. Devin is launched with a gateway-owned ATIF export path; the regular, non-symlink export is copied into the durable job row after process exit and the source is then removed. Local stdio callers can page the native transcript in raw mode. Remote HTTP/OAuth callers cannot retrieve raw job results, native transcripts, instruction paths, or replay context.
llm_job_cancelCancel a running async job.
approval_listList recent Claude MCP-managed approval decisions recorded by the gateway.
Parameters:
limit (number, optional): Max records (1-500), default: 50cli (string, optional): Filter by "claude", "codex", "gemini", "grok", "mistral", "devin", or "cursor"Approval records are persisted to ~/.llm-cli-gateway/approvals.jsonl.
llm_request_resultRead back any persisted request — sync or async — by its correlation ID. Every response echoes its ID in structuredContent.correlationId; pass it here to recover the persisted prompt/response after the inline result is gone. Reads the flight recorder, so it works independently of async-job persistence (returns "not found" when flight recording is disabled).
Parameters:
correlationId (string, required): Correlation ID from a prior requestmaxChars (number, optional): Max chars of the persisted response to return (1,000-2,000,000)includePrompt (boolean, optional): Include the full persisted prompt text, default: falseincludeJobRecord (boolean, optional): Include the linked raw provider capture and replay context for local stdio callers, default: false. Remote callers receive neither transcripts nor host paths.llm_request_listList recent persisted requests newest-first without a correlation ID, which is how you find one. Every other flight-recorder read is keyed by an id handed out inline to the caller that made the request, so an agent that did not make the call (or whose context was compacted since) starts here. Returns metadata only: pass a returned correlationId to llm_request_result for the bodies, or a returned asyncJobId to llm_job_status. A caller only ever sees its own requests. An empty list is not proof nothing ran, and it does not mean the work left no record: cross-LLM validation seats write no row here, but they write validation_runs and validation_run_jobs, and each of those links a job row holding the launched argv and the provider output (read it with validation_receipt, then llm_job_result). Flight recording can also be disabled. Jobs and requests are both unbounded by default; an operator can configure their bounds independently.
Parameters:
limit (number, optional): Max rows, 1-200, default: 25since (string, optional): ISO-8601 lower bound, e.g. 2026-08-21T00:00:00Zcli (string, optional): Restrict to one provider as recordedsessionId (string, optional): Restrict to one gateway session idllm_process_healthReport gateway process health: async-job manager state, the resolved durable persistence configuration, and flight-recorder health on that configured engine. With backend = "postgres", the recorder reports the opaque postgresql target and generic PostgreSQL failures, and never falls back to SQLite. Its warning also states that rows left in the previous engine were not migrated. The explicit LLM_GATEWAY_LOGS_DB=none recorder-off switch remains separate, as do the intentionally ephemeral memory and disabled none job-store modes.
upstream_contractsReturn the gateway's declared provider CLI contracts, optionally probing the installed binaries for drift.
Parameters:
cli (string, optional): Filter (claude|codex|gemini|grok|mistral|devin|cursor)probeInstalled (boolean, optional, default false): Run local --help probes and compare advertised flags against the declared contract — strongly recommended after any provider CLI upgrade. The probe reports missingFlags, extraFlags, acknowledgedExtraFlags (known upstream-only flags filtered from extraFlags), discoveredFlags, and stale-marker warnings.session_createCreate a new session for a specific CLI.
Parameters:
cli (string, required): CLI to create session for ("claude", "codex", "gemini", "grok", "mistral", "devin", "cursor")description (string, optional): Description for the sessionsetAsActive (boolean, optional): Set as active session, default: trueExample:
session_listList all sessions, optionally filtered by CLI.
Parameters:
cli (string, optional): Filter by CLI ("claude", "codex", "gemini", "grok", "mistral", "devin", "cursor")Response includes:
session_set_activeSet the active session for a specific CLI.
Parameters:
cli (string, required): CLI to set active session forsessionId (string, required): Session ID to activate (or null to clear)session_getRetrieve details for a specific session.
Parameters:
sessionId (string, required): Session ID to retrievesession_deleteDelete a specific session.
Parameters:
sessionId (string, required): Session ID to deletesession_clear_allClear all sessions, optionally for a specific CLI.
Parameters:
cli (string, optional): Clear sessions for specific CLI onlylist_modelsList available models for each CLI.
Parameters:
cli (string, optional): Specific provider to list models for ("claude", "codex", "gemini", "grok", "mistral", "devin", "cursor", or an enabled API provider name). When one or more [providers.<name>] API providers are enabled, the unfiltered response also carries an apiProviders array (each entry tagged providerKind: "api"); see API providers (HTTP).Response includes:
defaultModel and defaultModelSource when a default is explicitly configuredmodelMetadata with source/confidence (fallback, config, env, observed)aliases and warnings when configured or when discovery degrades gracefullyThe registry treats explicit configuration as authoritative. Bundled fallback models are low-confidence hints, and Gemini models observed in local session history are merged as low-confidence entries only; they do not become the default model.
Model registry environment overrides:
provider_tool_capabilitiesReport the provider tool and feature capability catalog. Use this before orchestrating provider-specific requests so callers can distinguish supported controls, provider-owned configuration, ignored parity fields, and unsupported inputs.
Parameters:
cli (string, optional): Provider filter ("claude", "codex", "gemini", "grok", "mistral", "devin", "cursor", "grok_api", or an enabled API provider name)includeSkills (boolean, default true): Include bounded local skill discoveryincludeProviderTools (boolean, default true): Include provider-native tools extracted from discovered skillsincludeUnsupported (boolean, default true): Include explicit unsupported/degraded input recordsincludePaths (boolean, default false): Include raw local filesystem paths in discovery outputrefresh (boolean, default false): Bypass the short-lived capability cacheThe response schema is provider-tool-capabilities.v2. Capability discovery is
read-only and bounded; raw local paths are redacted unless includePaths is
explicitly true, and secret-bearing auth files are not read.
Equivalent MCP resources:
provider-tools://catalog: full provider catalogprovider-tools://claudeprovider-tools://codexprovider-tools://geminiprovider-tools://grokprovider-tools://grok_apiprovider-tools://mistralprovider-tools://devinprovider-tools://cursorprovider-tools://<api-provider> for each enabled [providers.<name>] API providerdoctor --json also emits a compact provider_capabilities block with the
same schema version, per-provider request tool names, supported feature names,
unsupported input names, config-surface counts, discovery counts, and resource
URIs. This block is intended for setup assistants that need a concise capability
summary without local skill bodies or raw paths. When API providers are enabled,
doctor --json additionally emits an api_providers health block; see
API providers (HTTP).
cli_versionsReport installed CLI versions.
Parameters:
cli (string, optional): Specific CLI to inspect ("claude", "codex", "gemini", "grok", "mistral", "devin", "cursor")cli_upgradePlan or run an upgrade for one CLI.
Parameters:
cli (string, required): CLI to upgrade ("claude", "codex", "gemini", "grok", "mistral", "devin", "cursor")target (string, optional): Package tag/version/target, default: latestdryRun (boolean, optional): Return the upgrade plan without running it, default: truetimeoutMs (number, optional): Upgrade timeout when dryRun=falseUpgrade strategies:
claude updateclaude install <target>codex updatenpm install -g @openai/codex@<target>agy update (Antigravity self-update; explicit version targets are unsupported)grok updategrok update --version <target>pip/uv/brew); errors with guidance when none is detected (Vibe ships no self-update command)devin update (self-update; explicit version targets are unsupported)cursor-agent update (self-update; explicit version targets are unsupported)Example dry run:
In addition to the spawnable CLI tools, the gateway can route requests to first-class HTTP/API providers (OpenRouter and other OpenAI-compatible endpoints, the Anthropic Messages API, and the xAI Responses API). These use Node's built-in HTTP client (node:https, or node:http for loopback endpoints) rather than spawning a CLI, and they run through the same request/job/validation/flight-recorder machinery as the CLI tools, so they reach parity for sessions, async jobs, dedup, retries, usage/cost capture, and cross-LLM validation.
API providers are declared as [providers.<name>] blocks in ~/.llm-cli-gateway/config.toml (override with LLM_GATEWAY_CONFIG). The <name> becomes the provider's identity across every tool and resource and must not collide with a spawnable CLI name (claude, codex, gemini, grok, mistral, devin, cursor); a collision is rejected with a warning and the provider is disabled.
A provider is enabled when its api_key_env resolves to a non-empty value, OR it is a keyless-local openai-compatible provider on a loopback base_url. base_url must use https unless it targets localhost/loopback. A schema-invalid single [providers.<name>] block disables only itself (with a warning) and leaves the other providers untouched; a TOML syntax error anywhere in the file is different, it makes the whole config fall back to defaults.
The pre-existing [providers.xai] block keeps its dedicated grok_api_request tool and xAI identity. It is also exposed through the generic surface like any other enabled provider, so a configured xAI key registers both grok_api_request and the generic api_xai_request (and the xai entry appears in apiProviders, models://xai, etc.).
For each enabled provider, the gateway registers api_<name>_request (and api_<name>_request_async when async jobs are enabled). They accept the same shape as the CLI request tools:
prompt (or the cache-aware promptParts { system?, tools?, context?, task }, mutually exclusive), optional systemmodel (omit to use default_model; an explicit value is rejected if outside a configured models allowlist), maxOutputTokens, temperature, topPreasoningEffort (none|low|medium|high): forwarded only by the xai-responses adapter; accepted but ignored by the other kindstimeoutMs, optimizePrompt, optimizeResponse, forceRefresh, correlationIdsessionId / createNewSession for continuity on the synchronous api_<name>_request (see below); on the async variant they are currently inertResponses (and the 50 MB output cap, dedup window, cancellation, retention) behave exactly as for the CLI tools, and HTTP requests are logged to the flight recorder with status/usage/cost like everything else.
Continuity is capability-typed per provider kind and never stores conversation content in the session record (the gateway's no-transcript-in-sessions invariant holds):
xai-responses uses real server-side continuation: the gateway persists the provider's previous_response_id in session metadata and threads it back on resume, self-healing on a stale-handle 404.openai-compatible and anthropic are stateless-resend: the session tracks active/owner state for principal isolation, but the caller resends prior context (no server-side conversation handle exists).Enabled API providers appear, alongside the CLI providers, across the discovery surfaces. The model, capability, doctor, and resource surfaces below omit their API field entirely when no API providers are enabled, so their output is byte-identical to before; llm_process_health is the exception (it always carries an apiProviders array that is simply empty when none are enabled):
list_models / list_available_models: an apiProviders array tagged providerKind: "api" with defaultModel and the optional allowlist, omitted entirely when no API providers are enabled.llm_process_health: an always-present outboundProviders.apiProviders array (empty when none are enabled) carrying the same projection plus each provider's circuit-breaker state.provider_tool_capabilities: per-api-kind capability metadata. Model + sampling + (for xai-responses) reasoning + continuity are supported; allow/deny tool lists, MCP servers, local skills, and workspace/worktree controls are not (those are CLI-only).doctor --json: an api_providers health block (kind, base_url, default_model, models, the key env var name, whether the key is present, and login guidance), omitted entirely when none are enabled. The optional flag doctor --json --probe-api-providers adds a per-provider endpoint-reachability result (a bare GET, treating any HTTP response as reachable). The probe is opt-in and off by default: a normal doctor run opens no socket and spends no tokens (reachable stays null).models://<provider> for every enabled provider and sessions://<provider> for continuity-tracked kinds, plus provider-tools://<provider>. The provider-subcommands:// resources stay CLI-only (API providers have no subcommands).The API key value is never emitted on any of these surfaces (only the env var name and a presence boolean). Because base_url is config-supplied and may legally carry URL userinfo, the diagnostic surfaces (doctor, login guidance) redact any embedded credentials before displaying it; the actual request path and the reachability probe still use the original configured URL.
The resolved API key is excluded from payloadJson, the dedup key, logs, and the flight recorder. For ordinary non-Kit async jobs, the request prompt is persisted in plaintext in the async job store (SQLite at [persistence].path, default ~/.llm-cli-gateway/logs.db, or Postgres rows under backend = "postgres") and is not covered by secret redaction. This mirrors the CLI tools, whose prompt is persisted in argsJson whenever it is passed as a command argument rather than streamed over stdin. review_changes deliberately retains the complete fenced CLI prompt in expiry-bound payloadJson, stores only a hash marker in argsJson, and does not copy that prompt into the flight recorder. Personal Agent Config Kit durable rows use a separate privacy boundary: they do not persist compiled instructions or request arguments, and they withhold provider output and errors while retaining only the recovery and integrity state the Kit needs. Treat the job store as sensitive at rest. See Security Considerations and the Personal Agent Config Kit guide.
[persistence].backend in config.toml: sqlite/none keep ~/.llm-cli-gateway/sessions.json, postgres selects the PostgreSQL session manager. DATABASE_URL is a DEPRECATED override retained for compatibility; it warns once and is refused outright when it disagrees with an explicit [persistence].dsn. Note the PostgreSQL session store has no TTL eviction, where the file store reaps at 30 days; see the 3.1.0 notes.claude_request with continueSession:true uses Claude's latest conversation in a stable selected working directory and fails closed without workingDir or a registered workspace selected explicitly, through caller-owned session metadata, or by the configured default. That workspace may optionally supply a gateway worktree. codex_request needs a real Codex UUID for sessionId, or resumeLatest:true, which resumes a previous session. Do not rely on which session --last selects or on the resumed working directory (under review).session_delete removes gateway tracking from caller-visible session surfaces. For file-backed sessions, it also runs cleanup for associated gateway-owned lifecycle resources, such as a managed worktree. A durably owned worktree session remains as a hidden cleanup-pending tombstone until Git removal is verified; failed removal is retried when that store is registered on the owning host. It does not delete a provider's own stored conversation.
DEBUG: Enable debug logging (set to any value)
LLM_GATEWAY_APPROVAL_POLICY: Default approval policy for a Claude mcp_managed request when it does not pass approvalPolicy (strict, balanced, permissive). It has no effect on non-Claude adapters because they reject mcp_managed before launch.
LLM_GATEWAY_APPROVAL_ALLOW_BYPASS: Applies only to Claude approvalStrategy:"mcp_managed". A direct bypassPermissions request, or an unverified execution posture such as settings, instruction overrides, plugins, additional directories, worktrees, or native continuation, is denied by default regardless of approval score. Ordinary managed Claude requests use --permission-mode acceptEdits.
Set this to 1/true only to allow an explicit caller request through Claude's normal approval decision. The environment setting alone never escalates an ordinary managed Claude request. This setting does not enable mcp_managed on Codex, Gemini, Grok, Mistral, Devin, or Cursor: those adapters reject it before provider launch.
LLM_GATEWAY_TRUSTED_PRINCIPAL_HEADER: Name of an HTTP header carrying the authenticated user identity asserted by a trusted front door (any identity-aware reverse proxy / IdP). When set, the gateway adopts that header value as the request's ownership principal — but only for requests authenticated with the gateway's own static bearer token (i.e. the trusted upstream proxy), never from an arbitrary remote client. Off by default; IdP-agnostic. Lets a proxy-fronted multi-user deployment carry per-user identity into the gateway.
LLM_GATEWAY_OAUTH_REQUIRE_CONSENT / LLM_GATEWAY_OAUTH_CONSENT_SECRET: Opt-in human-consent gate for the built-in OAuth server. When enabled (REQUIRE_CONSENT=1, or implied by setting CONSENT_SECRET), /oauth/authorize renders an operator approval page (CSRF-protected) and issues an authorization code only after the dedicated consent password is entered — instead of auto-issuing. CONSENT_SECRET is the plaintext password (hashed in memory; or persist a consent_secret_hash in [http.oauth]). Off by default; remote OAuth refuses to enable consent without a secret to verify.
LLM_GATEWAY_CONFIG: Path to the gateway TOML config (default: ~/.llm-cli-gateway/config.toml). See Persistence configuration above for the [persistence] schema.
LLM_GATEWAY_SKILLS_PATH: Extra local skill-pack roots to load at startup, separated by the host path delimiter (: on Linux/macOS, ; on Windows). These paths are appended after [skills].paths; ~/.llm-cli-gateway/skills still loads last when present.
LLM_GATEWAY_LOGS_DB: Deprecated. When no backend is explicitly configured, selects backend = "sqlite" with this path (or backend = "none" when set to none). An explicit backend wins for job persistence. The variable still independently disables the recorder on every backend and paths it when SQLite is selected. Emits a deprecation warning at startup; migrate to config.toml.
LLM_GATEWAY_REDACT_LOGGED_SECRETS: Redact recognisable secrets (provider/cloud/VCS keys, bearer tokens, JWTs, PEM private keys, key=value secret assignments) from the prompt/system/response copies written to the flight-recorder log. Enabled by default; set to 0/false/off/no to store content verbatim. Only the audit log is affected — live sync responses and async llm_job_result output are never altered.
Each CLI can be configured through its own configuration files:
~/.claude/settings.json~/.codex/config.tomlagy): ~/.gemini/settings.jsonThe gateway provides detailed error messages for common issues:
Logs are written to stderr (stdout is reserved for MCP protocol):
Enable debug logging:
Make sure the CLIs are installed and in your PATH:
The gateway extends PATH to include common locations:
~/.local/bin/usr/local/bin/usr/bin~/.nvm/versions/node/*/bin directoriesIf you encounter permission errors, ensure the CLI tools have proper permissions:
These file checks apply only to the default file session manager. When [persistence].backend = "postgres" selects PostgreSQL session storage, sessions.json is not authoritative. Do not delete or edit session storage while gateway processes, provider children, or Personal Agent Config Kit attempts are active.
Use session_delete or session_clear_all for intentional gateway-record cleanup. Do not manually edit the file as a normal recovery method.
If a file-backed store is unreadable, inspect a copy only after the gateway is stopped:
For a stuck Personal Agent Config Kit attempt, do not reset sessions.json; follow the local-only recovery procedure in the Personal Agent Config Kit guide.
The gateway does not enforce a default execution timeout for LLM CLI requests.
If your MCP client/runtime enforces per-tool-call deadlines, use async tools (*_request_async + llm_job_status/llm_job_result) so long-running jobs can complete outside a single call window.
The gateway supports concurrent requests across different CLIs. Each request spawns a separate process.
[providers.<name>] HTTP providers, the gateway reads the key from the named environment variable at request time only. The resolved key is excluded from the persisted payloadJson, the dedup key, logs, and the flight recorder, and is never surfaced on the discovery/diagnostic surfaces (which report only the env var name and a presence boolean). base_url userinfo is redacted on the diagnostic surfaces. See API providers (HTTP).payloadJson, and CLI argsJson whenever the prompt is passed as a command argument rather than streamed over stdin); this is not covered by secret redaction. review_changes is explicit about its different CLI layout: the complete fenced prompt is retained in expiry-bound payloadJson, persisted argv contains only its hash marker, and the prompt is not copied into the flight recorder. Personal Agent Config Kit durable rows do not persist compiled instructions or request arguments and withhold provider output and errors, retaining only privacy-safe recovery and integrity state. The SQLite job-store file (default ~/.llm-cli-gateway/logs.db, configurable via [persistence].path) is chmoded to 0o600 on non-Windows hosts; the Postgres backend stores the corresponding fields in database rows. Treat either backend as sensitive and scope/rotate it like any prompt log. Set [persistence].backend = "none" to disable the async job store entirely (the *_request_async / llm_job_* tools are then not registered). See the Personal Agent Config Kit guide for its narrower durable-record boundary.spawn with separate arguments (not shell execution)ajv codegen case)SHA256SUMS.sigstore.json before trusting the checksum fileIf you're vetting llm-cli-gateway through Socket or a similar supply-chain scanner, you'll see behavioural alerts and some dependency-ownership alerts. They are accurate descriptions of what the package does and what it depends on. The reviewed shellAccess and shrinkwrap entries are configured in socket.yml for repository/PR policy surfaces, but Socket's public package page may still display them for the published npm artifact; the rationale remains documented here and in the package.
The currently flagged surfaces are not new in 2.6.x: the 2.3.0, 2.4.0, 2.5.0, and 2.6.3 npm tarballs all include npm-shrinkwrap.json, and all include the same dist/executor.js child-process spawn surface used to run provider CLIs. The socket.yml policy for 2.4.0, 2.5.0, 2.6.0, and 2.6.3 is materially the same for shellAccess; this README now adds the missing shrinkwrap disclosure as well.
| Alert | Where | Why it's bounded |
|---|---|---|
| Network access | src/http-transport.ts opens an HTTP MCP transport when started via npm run start:http. src/endpoint-exposure.ts issues a HEAD probe to verify configured public/tunnel URLs. Socket also flagged dist/upstream-contracts.js in v1.17.2 from descriptive text, not a network call. | The transport binds to 127.0.0.1 by default and requires LLM_GATEWAY_AUTH_TOKEN to be set. The default stdio MCP entry point (npm start) opens no sockets. src/upstream-contracts.ts stores provider CLI metadata and imports no HTTP client APIs. |
| Shell access | src/executor.ts uses child_process.spawn(cmd, args, …) to invoke the underlying LLM CLIs. | spawn is called with an argument array and never shell: true, so there is no shell interpolation path for caller input. The command name is never taken from caller input either: it is derived from the provider registry via providerCommandName(cli) for a CLI_TYPES member, or from a gateway-computed upgrade plan in src/cli-updater.ts (npm/pip/uv/brew). No MCP tool accepts a binary name. Note this is a property of every call site rather than a membership check inside src/executor.ts, which takes command as a string and does not filter it. |
| Published shrinkwrap | The npm artifact includes npm-shrinkwrap.json; package.json#files includes it and scripts/make-prod-shrinkwrap.mjs generates it from package-lock.json. | This is a CLI/application package. npm documents the shrinkwrap use case for applications, daemons, and command-line tools published through the registry. Our shrinkwrap is a prod-only projection, not a committed full dev lockfile: scripts/release-security-audit.sh verifies parity with the audited lockfile, and scripts/verify-registry-install.sh proves fresh registry consumers receive no better-sqlite3/prebuild-install/tar-fs/tar-stream production chain. |
| Uses eval | None in our source. Transitive: @modelcontextprotocol/sdk → ajv@8 uses new Function(...) in ajv/dist/compile/index.js to compile JSON Schema validators. | This is ajv's standard codegen path. Only known schemas (defined in our source and the MCP SDK) flow into it; no caller-supplied data ever reaches the compiled function body. |
| SQLite adapter isolation | The SQLite backend uses Node's built-in node:sqlite module (no native binding, no install scripts) through a single adapter, src/sqlite-driver.ts. | node:sqlite is touched by exactly one production module (the adapter); every other module talks to SQLite through its typed surface. We never call any db.pragma() helper (it does not exist on node:sqlite); SQLite setup uses fixed literal db.exec("PRAGMA ...") statements. npm run security:audit fails the release if production code references node:sqlite outside the adapter or reintroduces a .pragma() call. |
| Dependency ownership | A handful of small transitive packages (e.g. media-typer via @modelcontextprotocol/sdk) trip Socket's "unstable ownership" or "obfuscated code" heuristics. | These are pinned, well-known micro-deps in the Node ecosystem with no known issues. We pin direct override versions of content-type and type-is in package.json#overrides. As of 2.0.0 the prod graph carries no native module (better-sqlite3 moved to devDependencies; node:sqlite is built into Node), eliminating the entire prebuild-install/tar-fs/tar-stream install-time chain. Our earlier direct dependency on toml@3.0.0 was replaced with smol-toml. |
See socket.yml for the same context in machine-readable form.
npm testnpm run buildMIT. See LICENSE for details.
For issues and questions:
See CHANGELOG.md for detailed release history.