openclaw onboard.
For local servers that should start only when a selected model needs them, see Local model services.
Hardware floor
Aim for 2+ maxed-out Mac Studios or an equivalent GPU rig (~$30k+) for a comfortable agent loop. A single 24 GB GPU only handles lighter prompts at higher latency. Always run the largest / full-size variant you can host - small or heavily quantized checkpoints raise prompt-injection risk (see Security).Pick a backend
| Backend | Use when |
|---|---|
| ds4 | Local DeepSeek V4 Flash on macOS Metal with OpenAI-compatible tool calls |
| LM Studio | First-time local setup, GUI loader, native Responses API |
| LiteLLM / OAI-proxy / custom OpenAI-compatible proxy | You front another model API and need OpenClaw to treat it as OpenAI |
| MLX / vLLM / SGLang | High-throughput self-hosted serving with an OpenAI-compatible HTTP endpoint |
| Ollama | CLI workflow, model library, hands-off systemd service |
api: "openai-responses" when the backend supports it (LM Studio does). Otherwise use api: "openai-completions". If api is omitted on a custom provider with a baseUrl, OpenClaw defaults to openai-completions.
LM Studio + large local model (Responses API)
This is the best current local stack. Load a large model in LM Studio (a full-size Qwen, DeepSeek, or Llama build), enable the local server (defaulthttp://127.0.0.1:1234), and use the Responses API to keep reasoning separate from final text.
- Install LM Studio: https://lmstudio.ai
- Download the largest available model build (avoid “small”/heavily quantized variants), start the server, confirm
http://127.0.0.1:1234/v1/modelslists it. - Replace
my-local-modelwith the actual model ID shown in LM Studio. - Keep the model loaded; cold-load adds startup latency.
- Adjust
contextWindow/maxTokensif your LM Studio build differs. - For WhatsApp, stick to the Responses API so only final text is sent.
- Keep
models.mode: "merge"so hosted models stay available as fallbacks.
Hybrid config: hosted primary, local fallback
primary/fallbacks order and keep the same providers block and models.mode: "merge".
Regional hosting / data routing
Hosted MiniMax/Kimi/GLM variants also exist on OpenRouter with region-pinned endpoints (for example, US-hosted). Pick the regional variant to keep traffic in your chosen jurisdiction while keepingmodels.mode: "merge" for Anthropic/OpenAI fallbacks. Local-only is still the strongest privacy path; hosted regional routing is the middle ground when you need provider features but want control over data flow.
Other OpenAI-compatible local proxies
MLX (mlx_lm.server), vLLM, SGLang, LiteLLM, OAI-proxy, or any custom gateway works if it exposes an OpenAI-style /v1/chat/completions endpoint. Use openai-completions unless the backend explicitly documents /v1/responses support.
baseUrl origin for guarded model requests, including loopback, LAN, tailnet, and private DNS hosts. Metadata/link-local origins are always blocked regardless. Requests to other private origins still need models.providers.<id>.request.allowPrivateNetwork: true; set the trust flag to false to opt out of exact-origin trust.
models.providers.<id>.models[].id is provider-local - do not include the provider prefix. For an MLX server started with mlx_lm.server --model mlx-community/Qwen3-30B-A3B-6bit:
models.providers.mlx.models[].id: "mlx-community/Qwen3-30B-A3B-6bit"agents.defaults.model.primary: "mlx/mlx-community/Qwen3-30B-A3B-6bit"
input: ["text", "image"] on local or proxied vision models so image attachments get injected into agent turns. Interactive custom-provider onboarding infers common vision model IDs and only asks about unknown names; non-interactive onboarding uses the same inference, with --custom-image-input / --custom-text-input to override it.
Use models.providers.<id>.timeoutSeconds for slow local/remote model servers before raising agents.defaults.timeoutSeconds. The provider timeout covers connect, headers, body streaming, and the total guarded-fetch abort for model HTTP requests only - if the agent/run timeout is lower, raise that too, since the provider timeout cannot extend the whole run.
For custom OpenAI-compatible providers, a non-secret local marker such as
apiKey: "ollama-local" is accepted when baseUrl resolves to loopback, a private LAN, .local, or a bare hostname - OpenClaw treats it as a valid local credential instead of reporting a missing key. Use a real value for any provider that accepts a public hostname./v1 backends:
- OpenClaw treats these as proxy-style OpenAI-compatible routes, not native OpenAI endpoints.
- Native-OpenAI-only request shaping does not apply: no
service_tier, no Responsesstore, no OpenAI reasoning-compat payload shaping, no prompt-cache hints. - Hidden OpenClaw attribution headers (
originator,version,User-Agent) are not injected on custom proxy URLs.
-
String-only content: some servers accept only string
messages[].content, not structured content-part arrays. Setmodels.providers.<provider>.models[].compat.requiresStringContent: true. -
Strict message keys: if the server rejects message entries with more than
role/content, setcompat.strictMessageKeys: true. -
Bracketed tool text: some local models emit standalone bracketed tool requests as text, like
[tool_name]followed by JSON and[END_TOOL_REQUEST]. OpenClaw promotes those to real tool calls only when the name exactly matches a registered tool for the turn; otherwise it stays as hidden, unsupported text. - Unstructured tool-call-looking text: if a model emits JSON/XML/ReAct-style text that looks like a tool call but wasn’t a structured invocation, OpenClaw leaves it as text and logs a warning with the run id, provider/model, detected pattern, and tool name when available. That is provider/model incompatibility, not a completed tool run.
-
Forcing tool use: if tools show up as assistant text (raw JSON/XML/ReAct, or an empty
tool_callsarray), first confirm the server’s chat template/parser supports tool calls. If the parser only works when tool use is forced, override the default proxy value oftool_choice: "auto"per model:Use this only where every normal turn should call a tool. Replacelocal/my-local-modelwith the exact ref fromopenclaw models list, or set it via CLI: -
Extra reasoning efforts: if a custom OpenAI-compatible model accepts OpenAI reasoning efforts beyond the built-in profile, declare them in the model’s compat block. Adding
"xhigh"exposes it for that model ref in/think xhigh, session pickers, Gateway validation, andllm-taskvalidation:
Smaller or stricter backends
If the model loads cleanly but full agent turns misbehave, work top-down: confirm transport first, then narrow the surface.-
Confirm the local model responds - no tools, no agent context:
-
Confirm Gateway routing - sends only the prompt, skipping transcript, AGENTS bootstrap, context-engine assembly, tools, and bundled MCP servers, but still exercises Gateway routing, auth, and provider selection:
-
Try lean mode if both probes pass but real agent turns fail with malformed tool calls or oversized prompts: set
agents.defaults.experimental.localModelLean: true. It drops heavyweight browser, cron, message, media-generation, voice, and PDF tools unless explicitly required, and defaults larger tool catalogs behind structured Tool Search controls. See Experimental Features -> Local model lean mode for details and how to confirm it’s on. -
Disable tools entirely as a last resort by setting
models.providers.<provider>.models[].compat.supportsTools: falsefor that model - the agent then runs without tool calls. -
Past that, the bottleneck is upstream. If the backend still fails only on larger OpenClaw runs after lean mode and
supportsTools: false, the remaining issue is usually the model or server itself - context window, GPU memory, kv-cache eviction, or a backend bug - not OpenClaw’s transport layer.
Troubleshooting
- Gateway can’t reach the proxy?
curl http://127.0.0.1:1234/v1/models. - LM Studio model unloaded? Reload; cold start is a common “hanging” cause.
- Local server says
terminated,ECONNRESET, or closes the stream mid-turn? OpenClaw records a low-cardinalitymodel.call.error.failureKindplus the OpenClaw process RSS/heap snapshot in diagnostics. For LM Studio/Ollama memory pressure, match that timestamp against the server log or a macOS crash/jetsam log to confirm whether the model server was killed. - Context errors? OpenClaw derives context-window preflight thresholds from the detected model window (or the capped window when
agents.defaults.contextTokenslowers it), warning below 20% with an 8k floor and hard-blocking below 10% with a 4k floor (capped to the effective context window so oversized model metadata can’t reject a valid user cap). LowercontextWindowor raise the server/model context limit. messages[].content ... expected a string? Addcompat.requiresStringContent: trueon that model entry.validation.keys, or “message entries only allowroleandcontent”? Addcompat.strictMessageKeys: trueon that model entry.- Direct
/v1/chat/completionscalls work, butopenclaw infer model run --localfails on Gemma or another local model? Check the provider URL, model ref, auth marker, and server logs first -model runskips agent tools entirely. Ifmodel runsucceeds but larger agent turns fail, reduce the tool surface withlocalModelLeanorcompat.supportsTools: false. - Tool calls show up as raw JSON/XML/ReAct text, or the provider returns an empty
tool_callsarray? Do not add a proxy that blindly converts assistant text into tool execution - fix the server’s chat template/parser first. If the model only works when tool use is forced, add theparams.extra_body.tool_choice: "required"override above and use that model entry only for sessions where a tool call is expected every turn. - Safety: local models skip provider-side filters. Keep agents narrow and compaction on to limit prompt-injection blast radius.