✓ Verified 💻 Development ✓ Enhanced Data

Config Field

Validate OpenClaw configuration fields against the official Zod schema.

Rating: 4.2 (90 reviews)
Downloads: 1,216 downloads
Version: 1.0.0

Overview

Validate OpenClaw configuration fields against the official Zod schema.

Complete Documentation

View Source →

Config Field Validator

Validate OpenClaw configuration fields against the official Zod schema.

When to Use This Skill

Before editing configurations - Verify a field exists before adding it
Debugging config errors - Check if invalid fields are causing issues
Migrating configs - Validate fields after version upgrades
Reviewing configs - Ensure all fields are schema-compliant

How It Works

This skill automatically manages schema synchronization:

Check Version - Detects local OpenClaw version
Sync Schema - Downloads matching schema from GitHub if needed
Generate Fields - Parses Zod schema to extract field definitions
Validate - Uses generated schema to validate configuration

Quick Start

bash

# Validate a single field (auto-syncs schema if needed)
python3 scripts/validate_field.py agents.defaults.model.primary

# Validate entire config file
python3 scripts/validate_config.py /path/to/openclaw.json

# Force schema re-sync
python3 scripts/sync_schema.py --force

# Check current schema status
python3 scripts/sync_schema.py --status

Field Path Format

Field paths use dot notation:

text

agents.defaults.model.primary              → agents.defaults.model.primary
channels.telegram.botToken                 → channels.telegram.botToken
tools.web.search.provider                  → tools.web.search.provider

Workflow

For Users

Simply use validation commands - schema sync is automatic:

bash

# This will auto-sync schema if version mismatch detected
python3 scripts/validate_field.py agents.defaults.timeoutSeconds

For Schema Management

bash

# Check schema status
python3 scripts/sync_schema.py --status
# Output: Schema version: 2.1.0 (matches OpenClaw)

# Force re-sync (if needed)
python3 scripts/sync_schema.py --force

# Generate fresh field reference
python3 scripts/generate_fields.py

Schema Storage

Schema is cached locally at:

text

~/.config/openclaw/skills/config-field/
├── schema/              # Downloaded TypeScript schema files
├── cache/               # Parsed schema cache
└── schema-fields.md     # Generated field reference

Reference

Complete Field Reference

references/schema-fields.md - Auto-generated from official Zod schema

Scripts

Script	Purpose
validate_field.py	Validate single field
validate_config.py	Validate entire config
field_info.py	Get field details
sync_schema.py	Manage schema sync
generate_fields.py	Regenerate field docs

Common Fields

Agent Configuration

agents.defaults.model.primary - Default model ID
agents.defaults.workspace - Workspace path
agents.defaults.timeoutSeconds - Request timeout
agents.defaults.sandbox.mode - Sandbox mode

Channel Configuration

channels.telegram.botToken - Telegram bot token
channels.discord.token - Discord bot token
channels.slack.botToken - Slack bot token

Tools

tools.web.search.enabled - Enable web search
tools.web.search.provider - Search provider
tools.exec.security - Execution security mode

Troubleshooting

Schema Out of Date

If you see warnings about unknown fields that should exist:

bash

# Force schema refresh
python3 scripts/sync_schema.py --force

Validation Errors

bash

# Check field info for correct usage
python3 scripts/field_info.py agents.defaults.model

# Verify config syntax
python3 scripts/validate_config.py ~/.config/openclaw/openclaw.json

Installation

Terminal bash


openclaw install config-field

Copied!

💻Code Examples

python3 scripts/sync_schema.py --status

python3-scriptssyncschemapy---status.txt

## Field Path Format

Field paths use dot notation:

tools.web.search.provider → tools.web.search.provider

toolswebsearchprovider--toolswebsearchprovider.txt

## Workflow

### For Users

Simply use validation commands - schema sync is automatic:

python3 scripts/generate_fields.py

python3-scriptsgeneratefieldspy.txt

## Schema Storage

Schema is cached locally at:

└── schema-fields.md # Generated field reference

-schema-fieldsmd--generated-field-reference.txt

## Reference

### Complete Field Reference
**[references/schema-fields.md](references/schema-fields.md)** - Auto-generated from official Zod schema

## Scripts

| Script | Purpose |
|--------|---------|
| `validate_field.py <path>` | Validate single field |
| `validate_config.py <file>` | Validate entire config |
| `field_info.py <path>` | Get field details |
| `sync_schema.py` | Manage schema sync |
| `generate_fields.py` | Regenerate field docs |

## Common Fields

### Agent Configuration
- `agents.defaults.model.primary` - Default model ID
- `agents.defaults.workspace` - Workspace path
- `agents.defaults.timeoutSeconds` - Request timeout
- `agents.defaults.sandbox.mode` - Sandbox mode

### Channel Configuration
- `channels.telegram.botToken` - Telegram bot token
- `channels.discord.token` - Discord bot token
- `channels.slack.botToken` - Slack bot token

### Tools
- `tools.web.search.enabled` - Enable web search
- `tools.web.search.provider` - Search provider
- `tools.exec.security` - Execution security mode

## Troubleshooting

### Schema Out of Date

If you see warnings about unknown fields that should exist:

example.sh

# Validate a single field (auto-syncs schema if needed)
python3 scripts/validate_field.py agents.defaults.model.primary

# Validate entire config file
python3 scripts/validate_config.py /path/to/openclaw.json

# Force schema re-sync
python3 scripts/sync_schema.py --force

# Check current schema status
python3 scripts/sync_schema.py --status

example.txt

agents.defaults.model.primary              → agents.defaults.model.primary
channels.telegram.botToken                 → channels.telegram.botToken
tools.web.search.provider                  → tools.web.search.provider

example.sh

# Check schema status
python3 scripts/sync_schema.py --status
# Output: Schema version: 2.1.0 (matches OpenClaw)

# Force re-sync (if needed)
python3 scripts/sync_schema.py --force

# Generate fresh field reference
python3 scripts/generate_fields.py

example.txt

~/.config/openclaw/skills/config-field/
├── schema/              # Downloaded TypeScript schema files
├── cache/               # Parsed schema cache
└── schema-fields.md     # Generated field reference

example.sh

# Check field info for correct usage
python3 scripts/field_info.py agents.defaults.model

# Verify config syntax
python3 scripts/validate_config.py ~/.config/openclaw/openclaw.json