ESC
Start typing to search...

Config Schema

Complete reference for the config.yaml configuration file.

Full Schema

config.yaml
# Telegram Configuration
telegram:
  apiId: ${TG_API_ID}           # Required: Telegram API ID
  apiHash: ${TG_API_HASH}       # Required: Telegram API Hash
  sessionFile: session.json     # Session storage file

# LLM Configuration
llm:
  provider: anthropic           # anthropic | openai | groq | ollama
  model: claude-sonnet-4-20250514
  apiKey: ${ANTHROPIC_API_KEY}
  maxTokens: 4096
  temperature: 0.7
  fallback:                     # Optional fallback provider
    provider: groq
    model: llama-3.1-70b-versatile
    apiKey: ${GROQ_API_KEY}

# Wallet Configuration
wallet:
  network: mainnet              # mainnet | testnet
  version: W5R1                 # Wallet version

# Memory Configuration
memory:
  embeddings:
    provider: local             # local | voyage
    model: all-MiniLM-L6-v2
  autoCompact: true
  compactThreshold: 1000

# Access Control
policy:
  defaultScope: dm              # admin | dm | group
  adminUsers:
    - 123456789                 # Telegram user IDs

# WebUI Configuration
webui:
  enabled: false
  port: 3000
  host: localhost
  auth:
    username: admin
    password: ${WEBUI_PASSWORD}

# Scheduled Tasks
scheduler:
  tasks:
    - name: task-name
      cron: "0 9 * * *"
      prompt: "Task description"
      target: 123456789

# Plugins
plugins:
  - name: plugin-name
    path: ./plugins/plugin-name
    config:
      key: value

# MCP Servers
mcp:
  servers:
    - name: server-name
      command: npx
      args: ["-y", "@modelcontextprotocol/server-name"]
      env:
        KEY: ${VALUE}

Environment Variables

Use ${VAR_NAME} syntax to reference environment variables:

VariableDescriptionRequired
TG_API_IDTelegram API IDYes
TG_API_HASHTelegram API HashYes
ANTHROPIC_API_KEYAnthropic API keyYes*
OPENAI_API_KEYOpenAI API keyIf using OpenAI
GROQ_API_KEYGroq API keyIf using Groq
VOYAGE_API_KEYVoyage AI keyIf using Voyage

Default Values

KeyDefault
llm.maxTokens4096
llm.temperature0.7
wallet.networkmainnet
wallet.versionW5R1
memory.autoCompacttrue
memory.compactThreshold1000
policy.defaultScopedm
webui.enabledfalse
webui.port3000