SessionConfig

SessionConfigクラスで様々な設定が可能です。 Copilot::run(prompt: '...', config: $config)やCopilot::start(function (CopilotSession $session) { ... }, config: $config)のように使用します。単純にモデルを指定したいだけのようなSessionConfigクラスを使うまでもない時は配列での指定も可能です。Copilot::run(prompt: '...', config: ['model' => 'auto']) remoteSession設定は公式SDK 1.0.26で削除されました。SessionConfigとResumeSessionConfigでは指定できません。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\SystemMessageConfig;
use Revolution\Copilot\Types\InfiniteSessionConfig;
use Revolution\Copilot\Types\UserInputRequest;
use Revolution\Copilot\Types\AutoModeSwitchRequest;
use Revolution\Copilot\Types\ExitPlanModeRequest;
use Revolution\Copilot\Types\ExitPlanModeResult;
use Revolution\Copilot\Types\McpAuthRequest;
use Revolution\Copilot\Types\McpAuthToken;
use Revolution\Copilot\Types\MemoryConfiguration;
use Revolution\Copilot\Types\Rpc\ModelCapabilitiesOverride;
use Revolution\Copilot\Types\Rpc\ModelCapabilitiesOverrideSupports;
use Revolution\Copilot\Types\Rpc\ModelCapabilitiesOverrideLimits;
use Revolution\Copilot\Enums\ReasoningEffort;
use Revolution\Copilot\Enums\UIAutoModeSwitchResponse;
use Revolution\Copilot\Enums\MemoryMode;
use Revolution\Copilot\Enums\WorkingDirectoryTrust;

$config = new SessionConfig(
    // 使用するモデルの指定
    model: 'auto',

    // 新規セッション作成時に固定のセッションIDを指定
    sessionId: 'session-123',

    // ローカルセッションの作成時に名前を設定（cloud と併用するとランタイムが拒否）
    // 名前付きセッションは最初から永続化され、turn実行前でも一覧・再開できる。
    // 空文字・前後空白・制御文字・ダブルクォート不可、UTF-16コード単位で100以内。
    name: 'issue-triage',

    clientName: 'my-app',

    // 人が会話を行うセッションとして、ユーザーメッセージ分析テレメトリーを有効化（SDKの既定値: false）
    // 自動メッセージは対象外。cloudセッションおよび実行中セッションの再開時は無視される。
    interactiveUser: true,

    // 推論レベル。対応しているモデルでのみ設定可能。
    reasoningEffort: ReasoningEffort::HIGH,

    // モデルのcapabilitiesをオーバーライド。ランタイムのデフォルトにdeep-mergeされる。
    // modelCapabilities: new ModelCapabilitiesOverride(
    //     supports: new ModelCapabilitiesOverrideSupports(vision: true, reasoningEffort: true),
    //     limits: new ModelCapabilitiesOverrideLimits(max_prompt_tokens: 200000),
    // ),
    // 配列での指定も可能
    // modelCapabilities: ['supports' => ['vision' => true]],

    // configディレクトリを上書き設定
    configDirectory: '',

    // MCP設定やスキルディレクトリの自動検出を有効化
    // .mcp.json や .vscode/mcp.json をワーキングディレクトリから自動検出し、
    // 明示的に指定した mcpServers や skillDirectories とマージする（名前衝突時は明示指定が優先）
    enableConfigDiscovery: true,

    // カスタムツール
    tools: [...],

    // システムメッセージ
    systemMessage: new SystemMessageConfig(
        content: 'You are a helpful assistant for Laravel developers.',
    ),

    // システムメッセージ: replaceモード（システムプロンプトを完全に置き換え）
    // systemMessage: new SystemMessageConfig(
    //     mode: 'replace',
    //     content: 'カスタムシステムプロンプト全体',
    // ),

    // システムメッセージ: customizeモード（セクション単位でオーバーライド）
    // systemMessage: new SystemMessageConfig(
    //     mode: 'customize',
    //     sections: [
    //         'tone' => new SectionOverride(action: SectionOverrideAction::REPLACE, content: 'Always respond in Japanese.'),
    //         'safety' => new SectionOverride(action: SectionOverrideAction::REMOVE),
    //         'custom_instructions' => new SectionOverride(action: SectionOverrideAction::APPEND, content: 'Additional instructions here.'),
    //     ],
    //     content: 'appendモード同様の追加コンテンツ（オプション）',
    // ),

    // カスタムプロバイダー
    provider: new ProviderConfig(),

    // セッションごとのGitHubトークン（マルチテナント対応）
    // クライアントレベルのgithub_tokenとは別に、セッション単位でトークンを指定できる
    gitHubToken: $user->github_token,

    // メモリ設定 (experimental)
    // modeを省略するとsystem-promptを使用する。user-promptを指定すると生成されるユーザーメッセージへ注入する。
    memory: new MemoryConfiguration(
        enabled: true,
        mode: MemoryMode::UserPrompt,
    ),
    // 配列での指定も可能
    // memory: ['enabled' => true, 'mode' => 'user-prompt'],

    // クラウドセッション（ローカルではなくクラウドでセッションを作成）
    // オプションでリポジトリ情報を関連付けられる
    cloud: new \Revolution\Copilot\Types\CloudSessionOptions(
        repository: new \Revolution\Copilot\Types\CloudSessionRepository(
            owner: 'myorg',
            name: 'myrepo',
            branch: 'main',
        ),
    ),

    onPermissionRequest: function (array $request) {
        // 権限リクエストを処理
    },

    onUserInputRequest: function (UserInputRequest $request) {
        // ユーザーインプットリクエストを処理。ask_user
    },

    // エリシテーションリクエストのハンドラー
    // 設定するとエージェントからのフォームベースUIダイアログリクエストを受け取れる
    onElicitationRequest: function (ElicitationContext $context) {
        // エリシテーションリクエストを処理
        return ['action' => 'accept', 'content' => ['field' => 'value']];
    },

    // MCPサーバーがOAuth認証を要求したときにホスト側でトークンを取得
    onMcpAuthRequest: function (McpAuthRequest $request, array $context): ?McpAuthToken {
        $accessToken = $credentialProvider->tokenFor($request->serverName);

        return $accessToken === null
            ? null
            : new McpAuthToken(accessToken: $accessToken, tokenType: 'Bearer');
    },

    // プランモード終了リクエストのハンドラー
    // 設定するとreverse-RPCで応答し、省略時は自動承認される
    onExitPlanModeRequest: function (ExitPlanModeRequest $request) {
        // プラン内容を確認して承認・却下
        return new ExitPlanModeResult(approved: true, selectedAction: $request->recommendedAction);
    },

    // 自動モード切替リクエストのハンドラー
    // レートリミット到達時にautoモードへの切替を許可するか選択できる。省略時は "no"
    onAutoModeSwitchRequest: function (AutoModeSwitchRequest $request) {
        // "yes", "yes_always", "no" または UIAutoModeSwitchResponse を返す
        return UIAutoModeSwitchResponse::Yes;
    },

    // セッションフック
    hooks: [],

    // ワーキングディレクトリ
    workingDirectory: '',

    // ディレクトリの信頼範囲。User は後続セッションにも永続する
    trustWorkingDirectory: WorkingDirectoryTrust::Session,

    // ストリーミングを有効化
    streaming: true,

    // サブエージェントのストリーミングイベントをメインストリームに含めるか (デフォルト: true)
    includeSubAgentStreamingEvents: true,

    // 使用可能なビルトインツール
    availableTools: ['read_file', 'write_file'],

    // もしくは除外するツール
    excludedTools: ['shell'],

    // MCPサーバー設定
    mcpServers: [
        'github' => [
            'type' => 'http',
            'url' => 'https://api.githubcopilot.com/mcp/',
        ],
    ],

    // カスタムエージェント
    customAgents: [
        [
            'name' => 'reviewer',
            'displayName' => 'Code Reviewer',
            'description' => 'Reviews code for best practices',
            'prompt' => 'You are an expert code reviewer.',
        ],
    ],

    // デフォルトエージェントの設定。カスタムエージェントが選択されていない場合に使用されるビルトインエージェントの設定。
    // excludedTools: デフォルトエージェントから除外するツールのリスト。
    // カスタムサブエージェントには引き続き利用可能。
    defaultAgent: ['excludedTools' => ['tool_name']],

    // セッション開始時にアクティブにするエージェントを指定。customAgentsのnameと一致する必要がある。
    agent: 'reviewer',

    // スキル・エージェント・フック・指示ファイルの明示的な検出ルート
    skillDirectories: [],
    agentDirectories: [],
    hookDirectories: [],
    instructionDirectories: [],

    // 無効なスキル
    disabledSkills: [],

    // 無限セッション設定。デフォルトは有効。
    infiniteSessions: new InfiniteSessionConfig(
        enabled: true,
        backgroundCompactionThreshold: 0.80, // コンテキスト使用率が80%になったら圧縮を開始する
        bufferExhaustionThreshold: 0.95,     // 圧縮が完了するまで95%でブロックする
    ),

    // 無限セッションを無効化
    // infiniteSessions: new InfiniteSessionConfig(enabled: false),

    // セッション作成RPCより前にイベントハンドラを登録する。
    // session.start などの早期イベントを取りこぼさないようにするために使用する。
    // $session->on($handler) を後から呼ぶのと同等だが、ライフサイクルのより早い段階で登録される。
    onEvent: function (SessionEvent $event) {
        // すべてのセッションイベントを受け取る
    },
);

$response = Copilot::run('...', config: $config);

検出ルート

skillDirectories、agentDirectories、hookDirectories、instructionDirectories は、それぞれスキル・カスタムエージェント・ファイルフック・カスタム指示の検出専用ルートです。これらを指定しても、エージェントに一般的なファイルアクセス権限は付与されません。通常のファイルアクセス先を追加する場合は additionalDirectories を使います。検出ルートは enableConfigDiscovery の有効・無効にかかわらず指定できます。相対パスは指定時の有効な workingDirectory を基準に一度だけ解決され、後から作業ディレクトリが変わってもルートは移動しません。省略または null は既定の検出元を変更せず、[] はSDKが明示したルートだけをクリアします。スキル・エージェント・フック・指示ファイルそれぞれのソース無効化設定や Managed Settings は引き続き適用されます。

作業ディレクトリの信頼

trustWorkingDirectoryを指定すると、セッション作成時に作業ディレクトリを信頼済みとしてマークします。

WorkingDirectoryTrust::Sessionは現在のセッションだけディレクトリを信頼します。
WorkingDirectoryTrust::Userは信頼設定を永続化し、後続のセッションでもディレクトリを信頼します。

省略時は信頼状態を変更しません。trustWorkingDirectoryは新規セッション作成時のみ利用でき、ResumeSessionConfigには指定できません。

use Revolution\Copilot\Enums\WorkingDirectoryTrust;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    workingDirectory: base_path(),
    trustWorkingDirectory: WorkingDirectoryTrust::Session,
);

メモリの注入モード

メモリ設定は実験的機能です。

MemoryConfigurationはセッション間のメモリ機能を制御します。modeオプションでランタイムがメモリを注入する場所を指定します。

MemoryMode::SystemPrompt（system-prompt）はシステムプロンプトへメモリを注入します。modeを省略した場合の既定値です。
MemoryMode::UserPrompt（user-prompt）は生成されるユーザーメッセージへメモリを注入します。

use Revolution\Copilot\Enums\MemoryMode;
use Revolution\Copilot\Types\MemoryConfiguration;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    memory: new MemoryConfiguration(enabled: true, mode: MemoryMode::UserPrompt),
);

// 配列での指定も可能
$config = new SessionConfig(memory: ['enabled' => true, 'mode' => 'user-prompt']);

アプリ管理のメモリストア

MemoryConfigurationのstoreMemoryにクロージャーを渡すと、ランタイムが保存しようとしたメモリをアプリ側で受け取って保存できます。クロージャーにはStoredMemory（sessionId、subject、fact、citations、reason）と、キャンセルを確認できるsignalを持つMemoryStoreCallOptionsが渡されます。

use Revolution\Copilot\Types\MemoryConfiguration;
use Revolution\Copilot\Types\MemoryStoreCallOptions;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\StoredMemory;

$config = new SessionConfig(
    memory: new MemoryConfiguration(
        enabled: true,
        storeMemory: function (StoredMemory $memory, MemoryStoreCallOptions $options) use ($memoryRepository): void {
            if ($options->signal->isCancellationRequested()) {
                return;
            }

            $memoryRepository->store($memory);
        },
    ),
);

// 配列でも指定できる。storeMemoryにはClosureを渡す。
$config = new SessionConfig(memory: ['enabled' => true, 'storeMemory' => $storeMemory]);

storeMemoryを使う場合はenabledをtrueにします。falseのままだと例外になります。
storeMemory自体はRPCペイロードに含まれず、SDKはセッション作成・再開時にhasMemoryStore: trueだけを送ります。
クラウドセッションでは使用できません。
ランタイムはメモリを想起せず、vote_memoryも利用できなくなります。保存したメモリの想起はsystemMessageなどを使ってアプリ側で補ってください。
コールバックのsignalはタイムアウトや切断時にキャンセルされ、その後に返った結果は破棄されます。

権限モード

権限モードは実験的機能です。

permissionModeを指定すると、セッション作成・再開時に権限モードをランタイムへ伝えます。省略するとランタイムの既定のままです。PermissionMode enumまたは文字列で指定でき、ResumeSessionConfigでも同じように指定できます。クラウドセッションでは未対応です。

PermissionMode::Manual（manual）は通常の承認フローで権限リクエストを処理します。
PermissionMode::Assisted（assisted）は権限リクエストにLLMによる安全性の推奨を付けます。クライアントは問題ないと判断されたリクエストを自動承認できます。
PermissionMode::AllowAll（allow-all）はツール・パス・URLの権限リクエストを自動承認します。

use Revolution\Copilot\Enums\PermissionMode;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(permissionMode: PermissionMode::Assisted);

作成・再開の応答に適用結果が含まれている場合、$session->permissionModeResult()で取得できます。successは適用に成功したか、modeは適用後の権限モードです。応答に含まれない場合はnullを返します。

自動モードの回復

autoModeRecovery: trueを指定すると、アクティブなリクエストの自動回復をランタイムに依頼します。既定値はfalseです。この機能にはonAutoModeSwitchRequestハンドラーが必須で、指定しないと例外になります。回復の再試行や巻き戻しはランタイムが行うため、アプリ側でプロンプトを再送する必要はありません。

use Revolution\Copilot\Enums\UIAutoModeSwitchResponse;
use Revolution\Copilot\Types\AutoModeSwitchRequest;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    autoModeRecovery: true,
    onAutoModeSwitchRequest: function (AutoModeSwitchRequest $request) {
        // 回復オファーの場合は $request->autoModeRecovery にコンテキストが入る
        return UIAutoModeSwitchResponse::Yes;
    },
);

autoModeRecoveryは作成時・再開時の両方で指定します。ランタイムがcapabilities.ui.autoModeRecoveryをtrueとして応答しない場合、セッションは切り離され例外になります。この機能を使わない場合、既存のonAutoModeSwitchRequestによる将来のメッセージ向けの切り替え動作は変わりません。

Managed Settingsの適用除外

excludedManagedSettingsには、ランタイムが取得するManaged Settingsから除外する設定パスを配列で指定します。ホストがmanagedSettingsで直接注入する設定には影響しません。セッション再開後も除外を適用するには、ResumeSessionConfigにもexcludedManagedSettingsを再指定してください。

$config = new SessionConfig(
    excludedManagedSettings: ['permissions'],
);

セッション再開時にはResumeSessionConfigクラスを使用します。SessionConfigとほとんど同じですが少しだけ違います。ResumeSessionConfigは設定を変えたい項目のみ指定します。他は新規セッション開始時の設定が引き継がれます。 SDKは同じセッションオプションを作成時と再開時の両方のRPCペイロードに送信します。これにはBYOKのプロバイダーとモデル、メモリ、enableMcpApps、interactiveUser、autopilot、sandboxConfig、excludedManagedSettings、検出ルート、そしてonMcpAuthRequest・onExitPlanModeRequest・onAutoModeSwitchRequestなどのハンドラーが含まれます。再開時はResumeSessionConfigまたは同じキーを持つ配列で指定してください。クロージャーやプロバイダーオブジェクトは永続化されないため、再開のたびに再度指定する必要があります。

Autopilot の自動継続

Autopilot オプションは実験的機能です。

autopilotでAutopilotモード中の自動継続ポリシーを設定できます。セッションモード自体は変更しません。新規SDKセッションでは、省略時に自動継続が有効になり、maxContinuesは5です。maxContinuesに0を指定すると通常の自動継続を無効にできます。

use Revolution\Copilot\Types\Rpc\AutopilotOptions;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    autopilot: new AutopilotOptions(
        continuationEnabled: true,
        maxContinues: 3,
    ),
);

// 配列での指定も可能
$config = new SessionConfig(autopilot: [
    'continuationEnabled' => false,
    'maxContinues' => 0,
]);

再開時もResumeSessionConfigまたは配列で同じautopilotキーを使用します。warm resumeでは省略した項目の現在値が保持されます。runtime再起動後のcold resumeでは設定を再指定してください。

サンドボックス設定

サンドボックス設定は実験的機能です。

sandboxConfigでセッションのCLIサンドボックスを設定します。SDKは作成時と再開時の両方のリクエストでこの設定を送信します。既存コードとの互換性のためsandboxもエイリアスとして受け付け、両方を指定した場合はnullでないsandboxConfigを優先します。

use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    sandboxConfig: [
        'enabled' => true,
        'userPolicy' => [
            'filesystem' => ['readwritePaths' => [storage_path('app/workspace')]],
            'network' => [
                'allowedHosts' => ['api.example.com'],
                'blockedHosts' => ['untrusted.example.com'],
            ],
        ],
    ],
);

authとcredentialsを使うと、資格情報の値を公開せずにサンドボックス内のプロセスへ資格情報を渡せます。

authはgitとghへの資格情報注入を有効にします。
credentials.envVarsは環境変数名と、マスクされた値を受け取れるHTTPSホスト（injectHosts）を対応付けます。実際の資格情報値は設定に含めないでください。

$config = new SessionConfig(
    sandboxConfig: [
        'enabled' => true,
        'auth' => ['git' => true, 'gh' => true],
        'credentials' => [
            'envVars' => [
                'APP_CREDENTIAL' => ['injectHosts' => ['registry.example.com']],
            ],
        ],
        'userPolicy' => [
            'experimental' => ['seatbelt' => ['keychainAccess' => true]],
        ],
    ],
);

Revolution\Copilot\Types\Rpc名前空間のSandboxConfig、SandboxConfigAuth、SandboxCredentialsConfig、SandboxMaskedEnvVar、SandboxConfigUserPolicyExperimental、SandboxConfigUserPolicyExperimentalSeatbeltなどの型付きオブジェクトも使用できます。ネットワークの許可/拒否ルールはCLIのサンドボックス機能とバージョンに依存します。

キャンバスプロバイダー

キャンバスは実験的機能です。

canvasesでキャンバスを宣言し、canvasHandlerでopenとactionのリクエストを処理します。エージェントがキャンバスを開いたりアクションを呼び出したりすると、ランタイムはreverse-RPCでハンドラーを呼び出します。requestCanvasRenderer: trueを指定するとレンダラーとしてオプトインし、ランタイムはこの接続用のキャンバスエージェントツールをモデルに提供します。キャンバスを表示できないSDK呼び出し元がクリーンな状態を保つため、デフォルトはoffです。

use Revolution\Copilot\Support\CanvasError;
use Revolution\Copilot\Support\CanvasHandler;
use Revolution\Copilot\Types\CanvasDeclaration;
use Revolution\Copilot\Types\Rpc\CanvasAction;
use Revolution\Copilot\Types\Rpc\CanvasProviderInvokeActionRequest;
use Revolution\Copilot\Types\Rpc\CanvasProviderOpenRequest;
use Revolution\Copilot\Types\Rpc\CanvasProviderOpenResult;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    canvases: [
        new CanvasDeclaration(
            id: 'editor',
            displayName: 'Editor',
            description: 'Opens and edits project files.',
            actions: [
                new CanvasAction(name: 'format', description: 'Format the open file.'),
            ],
        ),
    ],
    canvasHandler: new class extends CanvasHandler
    {
        public function open(CanvasProviderOpenRequest $request): CanvasProviderOpenResult|array
        {
            return new CanvasProviderOpenResult(
                url: 'https://app.example.test/canvas/'.$request->instanceId,
                title: 'Project editor',
            );
        }

        public function invoke(CanvasProviderInvokeActionRequest $request): mixed
        {
            if ($request->actionName !== 'format') {
                throw CanvasError::noHandler();
            }

            return ['formatted' => true];
        }
    },
    requestCanvasRenderer: true,
);

SessionFsプロバイダー

スキルとファイルシステムのコールバック

skillProviderを使うと、アプリケーションが管理するソースからスキルを読み込めます。コールバックはそのセッションに属し、Copilotランタイムにはシリアライズされません。クラウドセッションではカスタムスキルプロバイダーはサポートされていません。

use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;
use Revolution\Copilot\Types\SkillProviderCallOptions;

$config = new SessionConfig(
    onPermissionRequest: PermissionHandler::approveAll(),
    skillProvider: [
        'listSkills' => fn (SkillProviderCallOptions $options) => [
            ['name' => 'deployment', 'description' => 'Safe application deployments'],
        ],
        'readSkill' => fn (string $name, SkillProviderCallOptions $options) =>
            $name === 'deployment' ? '# Deployment checklist' : null,
    ],
);

SkillProviderCallOptions::$signalでコールバックのキャンセルトークンを取得できます。キャンセルは協調的に行われるため、コールバック側でシグナルを監視し、保留中の処理を自らキャンセルしてください。コールバック配列の代わりにRevolution\Copilot\Contracts\SkillProviderを実装することもできます。 sessionFsProviderも同じセッション単位の設定を使用します。テキスト用のコールバックはreadFile(path)とwriteFile(path, content, mode)です。バイナリファイルをサポートするにはreadFileBytes(path)とwriteFileBytes(path, bytes, mode)の両方を指定するか、SessionFsBinaryProviderを実装します。これらのコールバックは元のバイト列をそのまま受け取り・返し、JSON-RPC上のbase64エンコードはSDKが処理します。ファイルシステムへのアクセスは、アプリケーションが公開を意図したパスに限定してください。

use Illuminate\Support\Facades\Storage;
use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;

$config = new SessionConfig(
    onPermissionRequest: PermissionHandler::approveAll(),
    sessionFsProvider: [
        'readFile' => fn (string $path) => Storage::disk('local')->get($path),
        'writeFile' => fn (string $path, string $content, ?int $mode = null) =>
            Storage::disk('local')->put($path, $content),
        'readFileBytes' => fn (string $path) => Storage::disk('local')->get($path),
        'writeFileBytes' => fn (string $path, string $bytes, ?int $mode = null) =>
            Storage::disk('local')->put($path, $bytes),
    ],
);

`sessionFs`でセッション状態全体を委譲する

クライアントオプションsessionFs（session_fsでも可）を指定すると、Copilot CLIのセッション状態（session-stateファイルやセッションごとのSQLiteデータベース）を独自のストレージへ委譲できます。この場合、すべてのセッション設定でcreateSessionFsProviderが必須です。createSession()とresumeSession()の両方で、セッションのIDが確定した後・ランタイムへのリクエスト送信前に呼び出されます。

use Revolution\Copilot\Client;
use Revolution\Copilot\Contracts\CopilotSession;
use Revolution\Copilot\Support\PermissionHandler;
use Revolution\Copilot\Types\SessionConfig;

$client = new Client(['sessionFs' => [
    'initialCwd' => '/workspace',
    'sessionStatePath' => '/session-state',
    'conventions' => 'posix', // または windows
    'capabilities' => ['sqlite' => true, 'binary' => true], // 任意
]]);

$session = $client->createSession(new SessionConfig(
    onPermissionRequest: PermissionHandler::approveAll(),
    createSessionFsProvider: fn (CopilotSession $session) => new MySessionFsProvider($session->id()),
));

Copilotファサードを使う場合はconfig/copilot.phpでsession_fsを設定します。initialCwd、sessionStatePath、conventions（posixまたはwindows）は必須です。項目が不足している場合やconventionsの値が不正な場合はInvalidArgumentExceptionになります。 createSessionFsProviderはClosureで、SessionConfigとResumeSessionConfigの配列/fromArray()/toArray()でも使えます。返すプロバイダーはオブジェクトでもcallableの配列でも構いません。オプションの機能ごとにインターフェースがあります。

インターフェース	追加されるもの
`SessionFsProvider`	`readFile`、`writeFile`
`SessionFsBinaryProvider`	`readFileBytes`、`writeFileBytes`（`capabilities.binary`で必須）
`SessionFsFilesystemProvider`	`appendFile`、`exists`、`stat`、`mkdir`、`readdir`、`readdirWithTypes`、`rm`、`rename`
`SessionFsSqliteCapableProvider`	`SessionFsSqliteProvider`（`query`、`exists`）を返す`sqlite()`。`capabilities.sqlite`で必須
`SessionFsSqliteTransactionProvider`	SQLiteプロバイダーの`transaction()`

プロバイダーが宣言したcapabilitiesを満たさない場合はInvalidArgumentExceptionになります。プロバイダーがサポートしていない操作を呼び出すとUNKNOWNエラーが返ります。プロバイダーは例外をスローして失敗を通知します。codeがENOENT（またはerrno 2）の例外はENOENTになり、それ以外はUNKNOWNになります。transaction()からSessionFsSqliteTransactionFailureをスローするとerrorClass（busyOrLocked、fatal、postCommitAmbiguous）を通知できます。クライアントオプションsessionFsが無い場合、createSessionFsProviderは呼び出されず、従来のsessionFsProvider（readFile/writeFile）がそのまま使えます。

マルチテナント向け empty モード

クライアント設定のmodeをemptyにすると、Copilot CLI のホスト環境やセッション間状態に依存する機能を既定で無効にします。省略時は従来どおりcopilot-cliです。empty モードでは永続化先としてbase_directory、session_fs、または外部サーバーのurlのいずれかを指定してください。

// config/copilot.php
'mode' => env('COPILOT_MODE', 'copilot-cli'),
'base_directory' => storage_path('app/copilot'),

empty モードでは各セッションにavailableToolsの指定が必要です。ToolSetを使うとソース修飾付きのツールフィルター（builtin:、custom:、mcp:）を組み立てられます。BuiltInTools::Isolatedは、ホストのファイルシステム・環境・ネットワーク・セッション間アクセスを持たない、単一セッション内で完結する組み込みツールだけを許可します。

use Revolution\Copilot\Facades\Copilot;
use Revolution\Copilot\Support\BuiltInTools;
use Revolution\Copilot\Support\ToolSet;

$response = Copilot::run(
    prompt: 'Summarize this text.',
    config: [
        'availableTools' => (new ToolSet)
            ->addBuiltIn(BuiltInTools::Isolated)
            ->addCustom('lookup_order')
            ->addMcp('search'),
    ],
);

ツール名は/^[a-zA-Z0-9_-]+$/に一致するか、ワイルドカード*である必要があります。それ以外の場合、ToolSetはInvalidArgumentExceptionをスローします。 empty モードではセッションテレメトリー、永続 MCP OAuth token storage、embedding retrieval/cache、instruction discovery、file hooks、host git operations、session store、skills、memory、experimental mode が安全側の既定値になります。明示したセッション設定はこれらの既定値より優先されます。GitHub cache store は empty モードの既定値でもセッション設定でもありません。SDK はセッション作成・再開のリクエストで enableGitHubCacheStore を送信しなくなり、配列設定に残ったキーは無視します。systemMessageのreplaceはそのまま利用でき、それ以外のモードではenvironment_contextセクションを除去します。CLI プロセスではCOPILOT_DISABLE_KEYTAR=1を設定します。クラウド実行は Cloud Sessions、Plugin Directory は Plugin Directories を参照してください。

最新情報は GitHub リポジトリを参照してください。

GitHub Copilot

SDK

AI SDK

VOICEVOX

スターターキット

フィード・RSS

ミドルウェア

SessionConfig

SessionConfig

検出ルート

作業ディレクトリの信頼

メモリの注入モード

アプリ管理のメモリストア

権限モード

自動モードの回復

Managed Settingsの適用除外

Autopilot の自動継続

サンドボックス設定

キャンバスプロバイダー

SessionFsプロバイダー

スキルとファイルシステムのコールバック

`sessionFs`でセッション状態全体を委譲する

マルチテナント向け empty モード

​SessionConfig

​検出ルート

​作業ディレクトリの信頼

​メモリの注入モード

​アプリ管理のメモリストア

​権限モード

​自動モードの回復

​Managed Settingsの適用除外

​Autopilot の自動継続

​サンドボックス設定

​キャンバスプロバイダー

​SessionFsプロバイダー

​スキルとファイルシステムのコールバック

​sessionFsでセッション状態全体を委譲する

​マルチテナント向け empty モード

SessionConfig

検出ルート

作業ディレクトリの信頼

メモリの注入モード

アプリ管理のメモリストア

権限モード

自動モードの回復

Managed Settingsの適用除外

Autopilot の自動継続

サンドボックス設定

キャンバスプロバイダー

SessionFsプロバイダー

スキルとファイルシステムのコールバック

`sessionFs`でセッション状態全体を委譲する

マルチテナント向け empty モード