Client Configuration

The client block controls how Vikat manages its internal worker pool, request logging, authentication enforcement, header policies, SDK compatibility shims, and MCP agent behaviour.

Connection Pool

Field	Type	Default	Description
`initial_pool_size`	integer	`300`	Pre-allocated worker goroutines per provider queue
`drop_excess_requests`	boolean	`false`	Drop requests when queue is full instead of waiting (returns HTTP 503 with `Retry-After: 1`)

A larger pool reduces latency spikes under burst load at the cost of higher baseline memory. 500–1000 is a common starting point for production workloads with multiple providers.

{
  "client": {
    "initial_pool_size": 1000,
    "drop_excess_requests": true
  }
}

Request & Response Logging

Field	Type	Default	Description
`enable_logging`	boolean	-	Log all LLM requests and responses
`disable_content_logging`	boolean	`false`	Strip message content from logs (keeps metadata only)
`log_retention_days`	integer	`365`	Days to retain log entries in the store
`logging_headers`	array of strings	`[]`	HTTP request headers to capture in log metadata

Set disable_content_logging: true where message content must not be persisted. That is one control among many a regime like HIPAA or PCI requires — it is not compliance by itself, and the semantic cache does not yet honour it (see the caching page).

{
  "client": {
    "enable_logging": true,
    "disable_content_logging": true,
    "log_retention_days": 90,
    "logging_headers": ["x-request-id", "x-user-id"]
  }
}

Reverse Proxy

When Vikat acts as an OAuth client to upstream MCP servers, the redirect_uri it registers is built from the incoming Host header by default - behind a reverse proxy that is the proxy’s internal address, not its public one. One setting lets you override it with the proxy’s public URL.

Field	Type	Default	Description
`mcp_external_client_url`	string or EnvVar	-	Public base URL Vikat uses as the `redirect_uri` against upstream MCP servers

This field supports env var syntax ("env.MY_VAR"). When unset, it falls back to the incoming Host header.

The client role

When Vikat connects to an upstream MCP server (Notion, Jira, GitHub, etc.) on behalf of a user, it acts as an OAuth client. mcp_external_client_url is the callback Vikat registers as its redirect_uri with those upstream providers - they redirect the user’s browser to <client URL>/api/oauth/callback after login. Set it to the proxy’s public URL so the callback resolves to a publicly reachable address.

Example

{
  "client": {
    "mcp_external_client_url": "env.VIKAT_EXTERNAL_URL"
  }
}

Or as a plain URL:

{
  "client": {
    "mcp_external_client_url": "https://oauth.yourcompany.com"
  }
}

When left empty, the redirect_uri falls back to the request’s Host header - correct for development or when no reverse proxy fronts Vikat. This setting is also configurable via the UI (MCP Gateway → MCP Settings) and the management API, with no restart required.

Security & CORS

Field	Type	Default	Description
`allowed_origins`	array	`["*"]`	CORS allowed origins (use URIs or `"*"`)
`enforce_auth_on_inference`	boolean	`false`	Require auth (virtual key, API key, or user token) on `/v1/*` inference routes
`max_request_body_size_mb`	integer	`100`	Maximum allowed request body size in MB
`whitelisted_routes`	array of strings	`[]`	Routes that bypass auth middleware
`allowed_headers`	array of strings	`[]`	Additional headers permitted for CORS and WebSocket
`allow_direct_keys`	boolean	`false`	Allow callers to bypass the registered key pool by sending `x-vikat-direct-key: true` and a raw provider key in `Authorization` / `x-api-key` / `x-goog-api-key`. See Direct API Key

{
  "client": {
    "allowed_origins": [
      "https://app.yourcompany.com",
      "https://admin.yourcompany.com"
    ],
    "enforce_auth_on_inference": true,
    "max_request_body_size_mb": 50,
    "whitelisted_routes": ["/health", "/metrics"]
  }
}

Header Filtering

Controls which x-vikat-eh-* extra headers are forwarded to upstream LLM providers.

Field	Type	Default	Description
`header_filter_config.allowlist`	array of strings	`[]`	Only these headers are forwarded (whitelist mode)
`header_filter_config.denylist`	array of strings	`[]`	These headers are always blocked
`required_headers`	array of strings	`[]`	Headers that must be present on every request (rejected with 400 if missing)

When both allowlist and denylist are empty, all x-vikat-eh-* headers pass through. Specifying an allowlist enables strict whitelist mode - only listed headers are forwarded.

{
  "client": {
    "header_filter_config": {
      "allowlist": [
        "x-vikat-eh-anthropic-version",
        "x-vikat-eh-openai-beta"
      ],
      "denylist": []
    },
    "required_headers": ["x-request-id"]
  }
}

Compat Shims

Compatibility flags that let Vikat silently adapt request/response shapes for SDK integrations.

Field	Type	Default	Description
`compat.convert_text_to_chat`	boolean	`false`	Wrap legacy `/v1/completions` text requests as chat messages
`compat.convert_chat_to_responses`	boolean	`false`	Translate chat completions to Responses API format
`compat.should_drop_params`	boolean	`false`	Silently drop unsupported parameters instead of erroring
`compat.should_convert_params`	boolean	`false`	Auto-convert parameter values across provider schemas

{
  "client": {
    "compat": {
      "should_drop_params": true,
      "convert_text_to_chat": true
    }
  }
}

MCP Agent Settings

Field	Type	Default	Description
`mcp_agent_depth`	integer	`10`	Maximum tool-call recursion depth for MCP agent mode
`mcp_tool_execution_timeout`	integer	`30`	Timeout per MCP tool execution in seconds
`mcp_code_mode_binding_level`	string	-	Code mode binding level: `"server"` or `"tool"`
`mcp_tool_sync_interval`	integer	`10`	Global tool sync interval in minutes (`0` = disabled)
`mcp_disable_auto_tool_inject`	boolean	`false`	When `true`, MCP tools are not automatically injected into requests

{
  "client": {
    "mcp_agent_depth": 15,
    "mcp_tool_execution_timeout": 60,
    "mcp_tool_sync_interval": 10
  }
}

Async Jobs

Field	Type	Default	Description
`async_job_result_ttl`	integer	`3600`	TTL (seconds) for async job results
`disable_db_pings_in_health`	boolean	`false`	Exclude database connectivity from `/health` endpoint checks

Prometheus Labels

Add custom labels to every Prometheus metric emitted by Vikat:

{
  "client": {
    "prometheus_labels": ["environment=production", "region=us-east-1"]
  }
}

Authentication

governance.auth_config protects the Vikat dashboard and management API with username/password auth.

Field	Type	Default	Description
`is_enabled`	boolean	`false`	Enable username/password auth
`admin_username`	string	-	Admin username
`admin_password`	string	-	Admin password (use `env.` reference)
`disable_auth_on_inference`	boolean	`false`	Skip auth check on `/v1/*` inference routes

{
  "governance": {
    "auth_config": {
      "is_enabled": true,
      "admin_username": "env.VIKAT_ADMIN_USERNAME",
      "admin_password": "env.VIKAT_ADMIN_PASSWORD",
      "disable_auth_on_inference": false
    }
  }
}

A top-level auth_config is also accepted for backwards compatibility, but governance.auth_config is the preferred location.

Encryption Key

{
  "encryption_key": "env.VIKAT_ENCRYPTION_KEY"
}

Notes
Accepts any string; Vikat derives a 32-byte AES-256 key using Argon2id
Can also be set via the `VIKAT_ENCRYPTION_KEY` environment variable
Once set and the database is populated, the key cannot be changed without clearing the database
Omitting the key stores data in plain text - not recommended for production

Full Example

{
  "$schema": "https://schema.vikat.ai",
  "encryption_key": "env.VIKAT_ENCRYPTION_KEY",

  "governance": {
    "auth_config": {
      "is_enabled": true,
      "admin_username": "env.VIKAT_ADMIN_USERNAME",
      "admin_password": "env.VIKAT_ADMIN_PASSWORD",
      "disable_auth_on_inference": false
    }
  },

  "client": {
    "initial_pool_size": 1000,
    "drop_excess_requests": true,

    "enable_logging": true,
    "disable_content_logging": false,
    "log_retention_days": 90,
    "logging_headers": ["x-request-id", "x-user-id"],

    "mcp_external_client_url": "env.VIKAT_EXTERNAL_URL",

    "allowed_origins": ["https://app.yourcompany.com"],
    "enforce_auth_on_inference": true,
    "max_request_body_size_mb": 100,

    "header_filter_config": {
      "allowlist": [],
      "denylist": []
    },
    "required_headers": [],

    "compat": {
      "should_drop_params": false
    },

    "prometheus_labels": ["environment=production"],

    "mcp_agent_depth": 10,
    "mcp_tool_execution_timeout": 30,

    "async_job_result_ttl": 3600
  }
}

Platform specific guides

Config as Code

Enterprise Deployment

Common setup instructions

Client Configuration

Connection Pool

Request & Response Logging

Reverse Proxy

The client role

Example

Security & CORS

Header Filtering

Compat Shims

MCP Agent Settings

Async Jobs

Prometheus Labels

Authentication

Encryption Key

Full Example

​Connection Pool

​Request & Response Logging

​Reverse Proxy

​The client role

​Example

​Security & CORS

​Header Filtering

​Compat Shims

​MCP Agent Settings

​Async Jobs

​Prometheus Labels

​Authentication

​Encryption Key

​Full Example

Connection Pool

Request & Response Logging

Reverse Proxy

The client role

Example

Security & CORS

Header Filtering

Compat Shims

MCP Agent Settings

Async Jobs

Prometheus Labels

Authentication

Encryption Key

Full Example