Config Reference

Map the major GraphJin configuration areas to focused guides and canonical source docs.

Start here

New to GraphJin configuration? How Configuration Works explains the mental model (one file, engine vs server settings, layered overrides) and every interface for changing config — editor autocomplete, the graphjin config CLI, the agent, MCP tools, and the gj_config control plane.

Major sections

Area	Guide
How configuration works	How Configuration Works
Sources mode	Sources Mode
Database config	Database Config
Auth and RBAC	Auth And RBAC
Caching and Redis	Caching And Redis
Discovery cache and semantic search	Discovery Cache And Semantic Search
Uploads and filesystems	Uploads And Filesystems
OpenAPI	OpenAPI Config
Environment and production	Environment And Production
MCP	MCP and MCP OAuth
Built-in agent	Server-Side Agent
Declared tasks	Durable Verified Tasks
Federation	Apollo Federation

Canonical source

The full field-by-field reference remains in CONFIG.md. This site turns that file into a progressive reading path but does not replace the checked-in reference.

Common source-mode skeleton

YAML

mode: agentic

identity:
  user_id_claim: sub
  namespace_claim: account_id
  role_claims: [role, roles]

sources:
  - name: app
    kind: database
    type: postgres
    default: true
    connection_string: ${DATABASE_URL}
    access:
      read: account
      write: blocked
      delete: blocked

system:
  root_access:
    gj_catalog: authenticated
    gj_security: admin
    gj_runtime: admin

Verified by TestConfigDocsTemplatesUseSources serv/mcp_config_docs_test.go:8

Verified by TestAgenticConfigDocsTemplate serv/mcp_config_docs_test.go:27

Validation surfaces

Change	Tests to look near
New source capability	`core/sourcecap`, catalog, security, MCP registration, and source access tests
New built-in feature capability	`core/featurecap`, system policy, security, MCP registration, and direct GraphQL tests
New config field	config decode/validation tests plus MCP config docs tests
New API or file provider	source-mode normalization and runtime init tests
New security default	`gj_security`, config scan, and caller capability profile tests

Validation

Configuration changes should be validated through the existing config and subsystem tests, especially when adding source capabilities, MCP settings, OpenAPI fields, or security defaults.