Skip to content
v9.1.1
Français

CopilotSettings

import type { CopilotSettings } from "@elie-laloum/outpost";

Parameters and properties

Section titled “Parameters and properties”
  • authenticationOptional
    AgentAuthentication | undefined
    Account forms only: “account” forwards the token that copilot login stored in ~/.copilot/config.json as COPILOT_GITHUB_TOKEN, key or variable forward a fine-grained token. Usage forms fail when the agent is composed, and classic ghp_ tokens are rejected.
  • variablesOptional
    Readonly<Record<string, string>> | undefined
    Environment variables for Copilot commands, merged over .outpost/.env; COPILOT_AUTO_UPDATE defaults to false. A name also set by the sandbox provider fails with code configuration.
  • conversationsOptional
    ConversationStore | undefined
    Store that captures, locates and restores Copilot session bundles instead of the default native store, such as createTransportConversations(createCopilotConversations(), …). A store that declares another format is rejected when the harness is created.
  • mcpServersOptional
    McpServers | undefined
    MCP servers passed to Copilot with —additional-mcp-config for each run, keyed by server name. Secrets stay ${NAME} references expanded by Copilot; each referenced variable must be declared.

Signature

Section titled “Signature”
export interface CopilotSettings {
  readonly authentication?: AgentAuthentication;
  readonly variables?: Variables;
  readonly conversations?: ConversationStore;
  readonly mcpServers?: McpServers;
}
Section titled “Related contracts”