Module config

Module config 

Source
Expand description

Configuration parsing and validation.

Context Harness is configured via a TOML file (default: config/ctx.toml). The config defines database paths, chunking parameters, embedding provider settings, retrieval tuning, server bind address, and connector configurations.

§Example Configuration

[db]
path = "./data/ctx.sqlite"

[chunking]
max_tokens = 700
overlap_tokens = 80

[embedding]
provider = "openai"           # "disabled" | "openai"
model = "text-embedding-3-small"
dims = 1536

[retrieval]
final_limit = 12
hybrid_alpha = 0.6            # 0.0 = keyword only, 1.0 = semantic only

[server]
bind = "127.0.0.1:7331"

[connectors.filesystem.docs]
root = "./docs"
include_globs = ["**/*.md", "**/*.txt"]

[connectors.git.platform]
url = "https://github.com/acme/platform.git"
branch = "main"

§Connectors

All connector types are named — you can configure multiple instances of each:

  • Filesystem ([connectors.filesystem.<name>]) — scan a local directory
  • Git ([connectors.git.<name>]) — clone/pull a Git repository
  • S3 ([connectors.s3.<name>]) — list and download from an S3 bucket
  • Script ([connectors.script.<name>]) — custom Lua-scripted data sources

§Validation

load_config performs the following validations:

  • chunking.max_tokens > 0
  • retrieval.final_limit >= 1
  • retrieval.hybrid_alpha ∈ [0.0, 1.0]
  • When embedding provider is openai or ollama: model and dims must be set
  • Embedding provider must be one of: "disabled", "openai", "ollama", "local"

Structs§

AgentsConfig
Container for all agent configurations.
ChunkingConfig
Text chunking parameters.
Config
Top-level configuration structure.
ConnectorsConfig
Container for all connector configurations.
DbConfig
Database configuration.
EmbeddingConfig
Embedding provider configuration.
FilesystemConnectorConfig
Filesystem connector configuration.
GitConnectorConfig
Git connector configuration.
InlineAgentConfig
Inline (TOML) agent configuration.
RegistryConfig
Extension registry configuration.
RetrievalConfig
Search and retrieval tuning parameters.
S3ConnectorConfig
Amazon S3 connector configuration.
ScriptAgentConfig
Lua script agent configuration.
ScriptConnectorConfig
Lua script connector configuration.
ScriptToolConfig
Lua tool script configuration.
ServerConfig
HTTP server configuration.
ToolsConfig
Container for all tool script configurations.

Functions§

default_agent_timeout 🔒
default_batch_size 🔒
default_candidate_k 🔒
default_doc_agg 🔒
default_final_limit 🔒
default_git_branch 🔒
default_git_root 🔒
default_group_by 🔒
default_hybrid_alpha 🔒
default_include_globs 🔒
default_max_chunks_per_doc 🔒
default_max_extract_bytes 🔒
default_max_retries 🔒
default_overlap 🔒
default_provider 🔒
default_s3_region 🔒
default_script_timeout 🔒
default_timeout_secs 🔒
default_tool_timeout 🔒
default_true 🔒
load_config
Load and validate a configuration file from disk.