Site Configuration Schema

Related Topics: Configuration (configuration guide) | dbt Integration (dbt setup) | Auditing (audit logs)

This reference documents the complete YAML schema for the mxcp-site.yml project configuration file.

Complete Example

mxcp: 1
project: my-analytics
profile: default

secrets:
  - db_credentials
  - api_key

extensions:
  - httpfs
  - parquet
  - name: h3
    repo: community

dbt:
  enabled: true
  model_paths: ["models"]

sql_tools:
  enabled: false

paths:
  tools: tools
  resources: resources
  prompts: prompts
  python: python
  sql: sql

profiles:
  default:
    duckdb:
      path: ./data/app.duckdb
      readonly: false

    drift:
      path: ./drift/snapshot.json

    audit:
      enabled: true
      path: ./audit/logs.jsonl

  production:
    duckdb:
      path: /data/prod.duckdb
      readonly: true

    audit:
      enabled: true
      path: /var/log/mxcp/audit.jsonl

Root Fields

Field	Type	Required	Default	Description
mxcp	integer	Yes	-	Schema version. Must be 1.
project	string	Yes	-	Project identifier. Used for matching user config.
profile	string	Yes	-	Active profile name. Must exist in profiles.
secrets	array	No	-	List of secret names used by the project.
extensions	array	No	-	DuckDB extensions to load.
dbt	object	No	-	dbt integration configuration.
sql_tools	object	No	-	Built-in SQL tools configuration.
plugin	array	No	-	Plugin definitions.
paths	object	No	-	Custom directory paths.
profiles	object	No	-	Profile-specific configurations.

Note: The mxcp field must be the integer 1. Unlike endpoint definitions (tools, resources, prompts), site config does not auto-coerce string values.

Project and Profile

mxcp: 1
project: my-project    # Unique project identifier
profile: default       # Active profile (must exist in profiles section)

The project name is used to match secrets and authentication in the user configuration file (~/.mxcp/config.yml).

The profile specifies which profile configuration to use. Switch profiles via:

mxcp serve --profile production

Profile Resolution Priority

The active profile is resolved in this order (highest to lowest priority):

1. CLI argument (--profile) - explicit override for a single command
2. Environment variable (MXCP_PROFILE) - session-level override
3. Site config (profile field) - project default

Secrets

List secret names that the project uses. Actual secret values are defined in the user configuration.

secrets:
  - db_credentials     # Database connection
  - api_key           # External API key
  - oauth_secret      # OAuth client secret

Secrets are accessed in Python endpoints:

from mxcp.runtime import config

# Returns dict with secret parameters, or None if not found
db_creds = config.get_secret("db_credentials")
if db_creds:
    host = db_creds.get("host")
    password = db_creds.get("password")

See User Configuration Schema for defining secret values.

Plugins

Register custom plugins to extend MXCP functionality.

plugin:
  - name: my_plugin
    module: plugins.my_module
    config: config/my_plugin.yml

  - name: analytics
    module: my_project.plugins.analytics

Field	Type	Required	Description
name	string	Yes	Plugin identifier.
module	string	Yes	Python module path to the plugin.
config	string	No	Optional path to plugin configuration file.

See Plugin Reference for complete plugin documentation.

Extensions

DuckDB extensions to load automatically.

Simple Extension Names

extensions:
  - httpfs       # HTTP file system
  - parquet      # Parquet file support
  - json         # JSON functions
  - spatial      # Geospatial functions

Extension with Repository

extensions:
  - name: h3
    repo: community

  - name: postgres_scanner
    repo: core_nightly

Field	Type	Required	Description
name	string	Yes	Extension name.
repo	string	No	Repository: community or core_nightly.

Common Extensions

Extension	Purpose
httpfs	Read files from HTTP/S3
parquet	Parquet file support
json	JSON functions
spatial	Geospatial functions
postgres_scanner	Query PostgreSQL
mysql_scanner	Query MySQL
sqlite_scanner	Query SQLite
excel	Read Excel files
h3	H3 geospatial indexing

dbt Configuration

Configure dbt integration for data transformation.

dbt:
  enabled: true
  model_paths: ["models"]
  analysis_paths: ["analyses"]
  test_paths: ["tests"]
  seed_paths: ["seeds"]
  macro_paths: ["macros"]
  snapshot_paths: ["snapshots"]
  target_path: "target"
  clean_targets: ["target", "dbt_packages"]

Field	Type	Default	Description
enabled	boolean	true	Enable dbt integration.
model_paths	array	["models"]	dbt model directories.
analysis_paths	array	["analyses"]	dbt analysis directories.
test_paths	array	["tests"]	dbt test directories.
seed_paths	array	["seeds"]	dbt seed directories.
macro_paths	array	["macros"]	dbt macro directories.
snapshot_paths	array	["snapshots"]	dbt snapshot directories.
target_path	string	"target"	dbt target directory.
clean_targets	array	["target", "dbt_packages"]	Directories to clean.

dbt Workflow

# Build dbt models
dbt run

# Run MXCP with dbt tables available
mxcp serve

See dbt Integration for complete documentation.

SQL Tools Configuration

Enable built-in SQL tools for direct database access.

sql_tools:
  enabled: true

Field	Type	Default	Description
enabled	boolean	false	Enable built-in SQL tools.

When enabled, provides these tools:

Tool	Description
execute_sql_query	Execute arbitrary SQL queries
list_tables	List all tables in the database
get_table_schema	Get schema for a specific table

Security Note: Only enable for trusted environments. Consider using custom tools with proper access controls for production.

Paths Configuration

Customize directory paths for endpoint definitions and data storage.

paths:
  tools: tools           # Tool YAML files
  resources: resources   # Resource YAML files
  prompts: prompts       # Prompt YAML files
  evals: evals           # Evaluation YAML files
  python: python         # Python implementation files
  plugins: plugins       # Plugin modules
  sql: sql               # SQL implementation files
  drift: drift           # Drift snapshots
  audit: audit           # Audit logs
  data: data             # Database files

Field	Type	Default	Description
tools	string	"tools"	Tool definitions directory.
resources	string	"resources"	Resource definitions directory.
prompts	string	"prompts"	Prompt definitions directory.
evals	string	"evals"	Evaluation definitions directory.
python	string	"python"	Python implementations directory.
plugins	string	"plugins"	Plugin modules directory.
sql	string	"sql"	SQL implementations directory.
drift	string	"drift"	Drift snapshot files directory.
audit	string	"audit"	Audit log files directory.
data	string	"data"	Database and data files directory.

All paths are relative to the project root.

Profiles

Define environment-specific configurations.

profiles:
  default:
    # Development settings
    duckdb:
      path: ./data/dev.duckdb
      readonly: false
    audit:
      enabled: false

  staging:
    duckdb:
      path: ./data/staging.duckdb
      readonly: false
    audit:
      enabled: true
      path: ./audit/staging.jsonl

  production:
    duckdb:
      path: /data/prod.duckdb
      readonly: true
    audit:
      enabled: true
      path: /var/log/mxcp/audit.jsonl

Profile Configuration

Field	Type	Description
duckdb	object	DuckDB database configuration.
drift	object	Drift detection configuration.
audit	object	Audit logging configuration.

DuckDB Configuration

duckdb:
  path: ./data/app.duckdb
  readonly: false

Field	Type	Default	Description
path	string	{paths.data}/db-{profile}.duckdb	Database file path.
readonly	boolean	false	Open database in read-only mode.

Path Behavior:

• If not specified, defaults to {paths.data}/db-{profile}.duckdb (e.g., data/db-default.duckdb)
• The paths.data value defaults to "data" but can be customized in the paths configuration
• Relative paths are resolved from project root
• Use absolute paths for production deployments
• Override with MXCP_DUCKDB_PATH environment variable

Drift Configuration

drift:
  path: ./drift/snapshot.json

Field	Type	Default	Description
path	string	{paths.drift}/drift-{profile}.json	Drift snapshot file path.

Path Behavior:

• If not specified, defaults to {paths.drift}/drift-{profile}.json (e.g., drift/drift-default.json)
• The paths.drift value defaults to "drift" but can be customized in the paths configuration

Use drift detection to track schema changes:

# Create/update snapshot
mxcp drift-snapshot

# Check for changes
mxcp drift-check

Audit Configuration

audit:
  enabled: true
  path: ./audit/logs.jsonl

Field	Type	Default	Description
enabled	boolean	false	Enable audit logging.
path	string	{paths.audit}/logs-{profile}.jsonl	Audit log file path (JSONL format).

Path Behavior:

• If not specified, defaults to {paths.audit}/logs-{profile}.jsonl (e.g., audit/logs-default.jsonl)
• The paths.audit value defaults to "audit" but can be customized in the paths configuration
• Override enabled state with MXCP_AUDIT_ENABLED environment variable (true/false, 1/0, yes/no)

Query audit logs:

mxcp log --since 1h
mxcp log --tool my_tool
mxcp log --status error

See Auditing for complete documentation.

Environment-Specific Examples

Development

mxcp: 1
project: my-app
profile: default

dbt:
  enabled: true

sql_tools:
  enabled: true  # Convenient for development

profiles:
  default:
    duckdb:
      path: ./data/dev.duckdb
      readonly: false
    audit:
      enabled: false

Production

mxcp: 1
project: my-app
profile: production

secrets:
  - db_credentials

extensions:
  - httpfs
  - parquet

dbt:
  enabled: true

sql_tools:
  enabled: false  # Disabled for security

profiles:
  production:
    duckdb:
      path: /data/prod.duckdb
      readonly: true
    drift:
      path: /var/lib/mxcp/drift.json
    audit:
      enabled: true
      path: /var/log/mxcp/audit.jsonl

Multi-Environment

mxcp: 1
project: analytics-platform
profile: default

secrets:
  - warehouse_credentials
  - api_keys

extensions:
  - httpfs
  - parquet
  - postgres_scanner

profiles:
  default:
    duckdb:
      path: ./data/local.duckdb
    audit:
      enabled: false

  staging:
    duckdb:
      path: ${STAGING_DB_PATH}
    audit:
      enabled: true
      path: ./logs/staging-audit.jsonl

  production:
    duckdb:
      path: ${PROD_DB_PATH}
      readonly: true
    audit:
      enabled: true
      path: /var/log/mxcp/production-audit.jsonl

Environment Variables

Use environment variables in configuration:

profiles:
  production:
    duckdb:
      path: ${DATABASE_PATH}
    audit:
      path: ${AUDIT_LOG_PATH}

Environment variables are expanded at runtime.

MXCP Environment Variables

Variable	Description
MXCP_PROFILE	Override the active profile (takes precedence over profile in site config)
MXCP_DUCKDB_PATH	Override DuckDB database path
MXCP_AUDIT_ENABLED	Override audit logging (true/false, 1/0, yes/no)

Validation

Validate your site configuration:

mxcp validate

Common validation errors:

Error	Solution
profile not found	Ensure profile value exists in profiles
missing required field	Add mxcp, project, and profile
invalid extension	Check extension name and repository

Next Steps

• User Configuration Schema - Configure secrets and authentication
• Configuration Guide - Complete configuration documentation
• dbt Integration - Set up data transformation
• Auditing - Configure audit logging