CommonAgentSettings

Parameters and properties

authenticationOptional
AgentAuthentication | undefined
Credential selection: “account” (subscription login), “usage” (API key), { account: { file | key | variable } } or { usage: { key | variable } }. Codex rejects account key and variable and accepts only usage with modelProvider; unsupported forms fail when the agent is composed. Omitted, Outpost installs no credentials.
variablesOptional
Readonly<Record<string, string>> | undefined
Environment variables for this CLI’s commands, merged over .outpost/.env; a name also set by the sandbox provider fails with code configuration. Claude Code rejects CLAUDE_CODE_MAX_OUTPUT_TOKENS or MCP_TIMEOUT here when maxOutputTokens or startupTimeoutMs already sets it.
saveConversationsOptional
boolean | undefined
Save the native conversation after each turn, default true. false disables capture and cannot be combined with conversations.
conversationsOptional
ConversationStore | undefined
Conversation store used instead of the native one, such as createTransportConversations() over the agent’s format. A store of another format, or saveConversations: false, fails when the harness is created.
mcpServersOptional
McpServers | undefined
MCP servers keyed by name, passed on the command line: —mcp-config for Claude Code, -c overrides for Codex. Secrets stay variable references; an undeclared referenced variable fails before the agent starts.

Signature

export interface CommonAgentSettings {
  readonly authentication?: AgentAuthentication;
  readonly variables?: Variables;
  readonly saveConversations?: boolean;
  readonly conversations?: ConversationStore;
  readonly mcpServers?: McpServers;
}

Parameters and properties

Signature

Related contracts