Safe, documented, schema-validated gateway configuration operations.
openclaw.json: read, analyze, modifyconfig.get, config.schema.lookup, config.patch, config.applyDetermine mode before starting any config work.
Trigger: user asks to check, review, compare, optimize, or analyze config, without providing a specific target value.
Flow:
config.schema.lookup for relevant keysOutput format:
## Config Analysis
**Finding**: what was found
**Current state**: relevant config values (from config.get)
**Schema evidence**: what schema.lookup confirmed
**Doc evidence**: source URL or QMD reference
**Recommendation**: suggested change (if any), or "no action needed"
Transitioning to Mode B: if user responds with explicit approval to execute a recommended change (e.g. "do it", "apply", "yes, modify it"), switch to Mode B. Start from Step 3 (Form Change Proposal) — Steps 1 and 2 evidence from Mode A can be reused.
Trigger: user explicitly requests a change AND provides sufficient detail (target key + intended value or clear intent). Examples:
Insufficient for Mode B (fall back to Mode A + ask):
Flow: all 6 steps below, in strict order. No step may be skipped.
| Situation | Action |
|---|---|
| ----------- | -------- |
| Mode A analysis done, user says "do it" | → Mode B, start from Step 3 (reuse Steps 1-2) |
| Mode B Step 3 proposal rejected | → Back to Mode A, re-analyze |
| User intent unclear | → Mode A, ask for clarification |
| Emergency config fix needed | → Still Mode B, but note "emergency" in log |
config.schema.lookup(path="target.config.key")
Verify:
enum values present → only use values from the enumadditionalProperties: false → no extra sub-fields allowedadditionalProperties: {}) → still verify field names from docsSchema has key + config doesn't: this means the key can be created. Proceed to Step 2.
Schema lookup fails or key doesn't exist: STOP. Do not proceed. Report to user.
This step is mandatory for both Mode A and Mode B.
Priority order (use first that works):
| Priority | Method | When to use |
|---|---|---|
| ---------- | -------- | ------------- |
| 1 | qmd__query | QMD has OpenClaw docs indexed → fastest, saves tokens |
| 2 | web_fetch("https://docs.openclaw.ai/ | QMD unavailable or no results |
| 3 | exec("openclaw | Docs site unreachable; last resort only |
What to verify:
If no documentation source covers the target config:
Present to user:
## Config Change Proposal
**Target**: full config key path
**Action**: add / modify / remove
**Current value**: (from config.get, or "does not exist")
**Proposed value**: exact new value
**Schema evidence**: type, enum, constraints from schema.lookup
**Doc evidence**: URL or "QMD:collection/doc-id" confirming correctness
**Impact**: what changes for the user
**Risk**: version constraints, provider limitations, side effects
Wait for explicit user approval. Quote the exact change.
All Mode B operations require confirmation. There are no exceptions — if the user already said "do it", that triggered Mode B, but Step 3 proposal must still be presented and acknowledged.
When in doubt: ask. Over-confirming is better than wrong changes.
5a. Backup first (always, before any modification):
exec("cp ~/.openclaw/openclaw.json ~/.openclaw/backups/openclaw-$(date +%Y%m%d%H%M%S).json")
If backup fails: STOP. Do not proceed without backup.
5b. Apply change (in preference order):
config.patch — partial updates, preferredconfig.apply — only for replacing entire config sectionsexec + Python JSON edit — only when config.patch cannot achieve the change (e.g. removing keys)One logical change per operation — see definition below.
1. config.get(path="target.key") → confirm value applied correctly
2. exec("openclaw config validate") → confirm config is valid
3. If gateway restart triggered → confirm restart succeeded
4. Record change to logs/config-changes.log
Change log format (append to ~/.openclaw/workspace/logs/config-changes.log):
## YYYY-MM-DDTHH:MM:SS+08:00
- action: add|modify|remove
- target: config.key.path
- old_value: <previous value or "N/A">
- new_value: <new value>
- reason: <brief justification>
- schema_verified: true
- doc_source: <URL or "QMD:collection/doc-id">
- user_approved: true
- backup: <backup file path>
A logical change = changes to keys within the same config subtree that serve a single user intent.
| Example | Count | Reason |
|---|---|---|
| --------- | ------- | -------- |
| Add one model entry | 1 | Single intent, one subtree |
| Add model + set it as fallback | 1 | Same intent (add fallback model), same subtree |
| Add model + add plugin + change channel | 3 | Different subtrees, different intents |
| Modify 3 unrelated fields in tools.* | 3 | Different intents, must be separate patches |
Rule of thumb: if you need to mention two different top-level config sections in one proposal, split it.
If in doubt, split. Smaller patches are safer and easier to roll back.
| Topic | URL |
|---|---|
| ------- | ----- |
| Config reference | https://docs.openclaw.ai/gateway/configuration-reference |
| Config examples | https://docs.openclaw.ai/gateway/configuration-examples |
| Models | https://docs.openclaw.ai/models/ |
| Plugins | https://docs.openclaw.ai/plugins/ |
| Channels | https://docs.openclaw.ai/channels/ |
| Tools | https://docs.openclaw.ai/tools/ |
| MCP | https://docs.openclaw.ai/tools/mcp |
| CLI reference | https://docs.openclaw.ai/cli/ |
| Security | https://docs.openclaw.ai/gateway/security |
| Sandbox | https://docs.openclaw.ai/gateway/sandboxing |
| Skills | https://docs.openclaw.ai/tools/skills |
| Multi-agent | https://docs.openclaw.ai/concepts/multi-agent |
| CLI backends | https://docs.openclaw.ai/gateway/cli-backends |
| Thinking levels | https://docs.openclaw.ai/tools/thinking |
| apply_patch | https://docs.openclaw.ai/tools/apply-patch |
| Web search | https://docs.openclaw.ai/tools/web-search |
| TTS | https://docs.openclaw.ai/tools/tts |
| Image gen | https://docs.openclaw.ai/tools/image-generation |
| Music gen | https://docs.openclaw.ai/tools/music-generation |
| Providers | https://docs.openclaw.ai/providers/ |
For nested structures, lookup sub-paths incrementally:
config.schema.lookup(path="agents.defaults.cliBackends")
config.schema.lookup(path="agents.defaults.cliBackends.*")
config.schema.lookup(path="agents.defaults.cliBackends.*.sessionMode")
Each level returns type, enum, children, and hints.
| Problem | Action |
|---|---|
| --------- | -------- |
| Gateway won't start | openclaw config validate --json → find specific errors |
| Unknown key error | Restore from backup → openclaw config unset |
| Type mismatch | Schema lookup for expected type → fix value → re-verify |
| Plugin fails to load | Check plugin docs for required config fields |
| config.patch rejected | Check schema for additionalProperties: false → verify all sub-fields |
| Patch succeeds but wrong value | Restore from backup → redo with correct value |
This skill covers openclaw.json configuration only.
共 1 个版本