Connector Config File Reference

This page documents the structure of axonflow.yaml for MCP connector configuration.

File Location

AxonFlow searches for the config file in this order:

AXONFLOW_CONFIG_FILE environment variable (if set)
./axonflow.yaml (current directory)
./config/axonflow.yaml
/etc/axonflow/axonflow.yaml

The community repo ships with config/axonflow.yaml for local development.

Basic Structure

version: "1.0"

connectors:
  my_postgres:
    type: postgres
    enabled: true
    display_name: "My Database"
    description: "Primary PostgreSQL database"
    connection_url: postgres://localhost:5432/mydb
    credentials:
      username: myuser
      password: mypassword
    options:
      max_open_conns: 10
    timeout_ms: 30000
    max_retries: 3

Common Fields

Field	Type	Description
`type`	string	Connector type
`enabled`	boolean	Whether the connector is active
`display_name`	string	Human-readable name
`description`	string	Connector purpose
`connection_url`	string	Connection string or base URL when applicable
`credentials`	object	Secrets or auth material
`options`	object	Connector-specific settings
`timeout_ms`	integer	Request timeout
`max_retries`	integer	Retry count
`tenant_id`	string	Optional tenant scoping

Environment Variable Expansion

AxonFlow supports environment variable expansion in the config file:

credentials:
  username: ${POSTGRES_USER:-postgres}
  password: ${POSTGRES_PASSWORD}

Production-Safe Starter Examples

PostgreSQL

connectors:
  customer_db:
    type: postgres
    enabled: true
    connection_url: postgres://localhost:5432/customers
    credentials:
      username: ${POSTGRES_USER:-postgres}
      password: ${POSTGRES_PASSWORD}
    options:
      max_open_conns: 10
      max_idle_conns: 5
      conn_max_lifetime: "5m"

HTTP

connectors:
  external_api:
    type: http
    enabled: true
    connection_url: https://api.example.com
    credentials:
      api_key: ${API_KEY}
    options:
      auth_type: api_key
      api_key_header: X-API-Key

Redis

connectors:
  cache:
    type: redis
    enabled: true
    connection_url: redis://redis.example.com:6379
    credentials:
      password: ${REDIS_PASSWORD}
    options:
      db: 0

Important Note on Connector Types

The wider docs site covers more connector types than the simplest self-hosted community starter path. If you are building a self-hosted community deployment, start with the connector types and examples that are actively documented and validated for that path, then expand from there as your edition and runtime surface grows.

That is especially important for teams assessing AxonFlow through the docs alone, because not every connector described on the site should be treated as equally available in every deployment path.

Practical Guidance

Use AXONFLOW_CONFIG_FILE to point the agent at one reviewed config file.
Keep secrets in environment variables or a managed secret source instead of hardcoding them into YAML.
Prefer a small number of well-governed connectors early, then expand once the usage pattern is proven.

File Location​

Basic Structure​

Common Fields​

Environment Variable Expansion​

Production-Safe Starter Examples​

PostgreSQL​

HTTP​

Redis​

Important Note on Connector Types​

Practical Guidance​

See Also​