1
>
/*---------------------------------------------------------------------------------------------
agentService.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import type { CancellationToken } from '../../../base/common/cancellation.js';
7
>
import { Event } from '../../../base/common/event.js';
8
>
import { IReference } from '../../../base/common/lifecycle.js';
9
>
import { truncate } from '../../../base/common/strings.js';
10
>
import { IAuthorizationProtectedResourceMetadata } from '../../../base/common/oauth.js';
11
>
import type { IObservable } from '../../../base/common/observable.js';
12
>
import { URI } from '../../../base/common/uri.js';
13
>
import type { IConfigurationChangeEvent, IConfigurationService } from '../../configuration/common/configuration.js';
14
>
import { createDecorator } from '../../instantiation/common/instantiation.js';
15
>
import type { IAgentServerToolHost } from './agentServerTools.js';
16
>
import type { IActiveSubscriptionInfo, IAgentSubscription } from './state/agentSubscription.js';
17
>
import type { IRemoteWatchHandle } from './agentHostFileSystemProvider.js';
18
>
import type { CompletionsParams, CompletionsResult, CreateTerminalParams, ResolveSessionConfigResult, SessionConfigCompletionsResult } from './state/protocol/commands.js';
19
>
import type { InitializeResult } from './state/protocol/common/commands.js';
20
>
import type { InvokeChangesetOperationParams, InvokeChangesetOperationResult } from './state/protocol/channels-changeset/commands.js';
21
>
import { ProtectedResourceMetadata, type Changeset, type ConfigSchema, type MessageAttachment, type ModelSelection, type AgentSelection, type SessionActiveClient, type ToolCallPendingConfirmationState, type ToolDefinition, ChangesSummary } from './state/protocol/state.js';
22
>
import type { ActionEnvelope, AuthRequiredParams, INotification, IRootConfigChangedAction, SessionAction, ChatAction, TerminalAction, ClientAnnotationsAction, ClientChangesetAction } from './state/sessionActions.js';
23
>
import type { ResourceCopyParams, ResourceCopyResult, ResourceDeleteParams, ResourceDeleteResult, ResourceListResult, ResourceMkdirParams, ResourceMkdirResult, ResourceMoveParams, ResourceMoveResult, ResourceReadResult, ResourceResolveParams, ResourceResolveResult, ResourceWatchState, ResourceWriteParams, ResourceWriteResult, CreateResourceWatchParams, CreateResourceWatchResult, IStateSnapshot } from './state/sessionProtocol.js';
24
>
import { ComponentToState, ChatInputResponseKind, SessionStatus, StateComponents, buildSubagentChatUri, parseRequiredSessionUriFromChatUri, type AgentCapabilities, type ClientPluginCustomization, type Customization, type PendingMessage, type RootState, type ChatInputAnswer, type SessionMeta, type ToolCallResult, type Turn, type PolicyState } from './state/sessionState.js';
25
>
26
>
// IPC contract between the renderer and the agent host utility process.
27
>
// Defines all serializable event types, the IAgent provider interface,
28
>
// and the IAgentService / IAgentHostService service decorators.
29
>
30
>
export const enum AgentHostIpcChannels {
31
>
/** Channel for the agent host service on the main-process side */
32
>
AgentHost = 'agentHost',
33
>
/** Channel for log forwarding from the agent host process */
34
>
Logger = 'agentHostLogger',
35
>
/** Channel for WebSocket client connection count (server process management only) */
36
>
ConnectionTracker = 'agentHostConnectionTracker',
37
>
/** Channel carrying raw Agent Host Protocol frames over a MessagePort. */
38
>
Protocol = 'agentHostProtocol',
39
>
/** Narrow local management channel that remains outside of the AHP data plane. */
40
>
Management = 'agentHostManagement',
41
>
/**
42
>
* Channel registered by the remote server that proxies AHP JSON-RPC
43
>
* frames between a renderer and the agent host running on the server.
44
>
* Pairs with `AgentHostIpcChannelTransport` on the renderer side.
45
>
*/
46
>
RemoteProxy = 'agentHostProxy',
47
>
}
48
>
49
>
/** Configuration key that controls whether AHP JSONL logs are written for agent host transports. */
50
>
export const AgentHostAhpJsonlLoggingSettingId = 'chat.agentHost.ahpJsonlLoggingEnabled';
51
>
52
>
/** Configuration key controlling automatic OS system proxy discovery for agent-host Copilot sessions. */
53
>
export const AgentHostSystemProxyEnabledSettingId = 'chat.agentHost.systemProxy.enabled';
54
>
55
>
// The Copilot-CLI-specific setting IDs (`customTerminalTool`, `opus48Prompt`,
56
>
// `reasoningEffortOverride`, `modelCapabilityOverrides`) live with their
57
>
// root-config keys in `copilotCliConfig.ts`.
58
>
59
>
/**
60
>
* Configuration key controlling whether the Claude provider is registered in
61
>
* the agent host process. When `false`, the agent host skips registering the
62
>
* Claude provider regardless of SDK availability. Defaults to `true`.
63
>
*
64
>
* Independent of {@link ClaudePreferAgentHostAgentsSettingId} /
65
>
* {@link ClaudePreferAgentHostEditorSettingId}, which control whether the
66
>
* workbench surfaces the agent host's Claude provider (vs. the GitHub Copilot
67
>
* Chat extension's). This setting is strictly about whether the agent host
68
>
* advertises Claude at all. The agent host process must be restarted for
69
>
* changes to take effect.
70
>
*/
71
>
export const AgentHostClaudeAgentEnabledSettingId = 'chat.agentHost.claudeAgent.enabled';
72
>
73
>
/**
74
>
* Configuration key controlling whether the Codex provider is registered in
75
>
* the agent host process. When `false` (the default), the agent host skips
76
>
* registering the Codex provider regardless of SDK availability. The agent
77
>
* host process must be restarted for changes to take effect.
78
>
*/
79
>
export const AgentHostCodexAgentEnabledSettingId = 'chat.agentHost.codexAgent.enabled';
80
>
81
>
/**
82
>
* Configuration key controlling whether the agent host *wires up* the BYOK
83
>
* ("bring your own key") language-model bridge: the renderer LM handler, the
84
>
* reverse-RPC channel, and the per-connection link to the node-side OpenAI
85
>
* proxy + bridge registry. When `true` (the default), the renderer's BYOK
86
>
* server channel and the per-connection bridge are wired so extension-provided
87
>
* BYOK models are reachable from agent-host sessions. When `false`, the proxy
88
>
* and registry are still constructed but stay inert — the BYOK server channel
89
>
* and the per-connection bridge are not wired, so the registry stays empty and
90
>
* extension-provided BYOK models are never reachable from agent-host sessions.
91
>
* The agent host process must be restarted for changes to take effect.
92
>
*/
93
>
export const AgentHostByokModelsEnabledSettingId = 'chat.agentHost.byokModels.enabled';
94
>
95
>
/**
96
>
* Optional override that points at an **SDK root directory** containing a
97
>
* `node_modules/@anthropic-ai/claude-agent-sdk` subtree. When set, the agent
98
>
* host loads the Claude SDK from that path instead of the bare import (which
99
>
* resolves via this repo's `node_modules` in dev) or the on-demand download
100
>
* from `product.agentSdks.claude` (built products). Mainly exists for the
101
>
* remote server's `--claude-sdk-root` CLI flag and for one-off developer
102
>
* overrides pointing at an out-of-tree SDK build.
103
>
*/
104
>
export const AgentHostClaudeSdkRootEnvVar = 'VSCODE_AGENT_HOST_CLAUDE_SDK_ROOT';
105
>
106
>
/**
107
>
* Environment variable form of {@link AgentHostClaudeAgentEnabledSettingId}.
108
>
* Set by the agent host starters from the setting. Accepts `'true'` /
109
>
* `'false'`; absent means "default" (`true` for Claude, `false` for Codex).
110
>
*/
111
>
export const AgentHostClaudeAgentEnabledEnvVar = 'VSCODE_AGENT_HOST_CLAUDE_AGENT_ENABLED';
112
>
113
>
/**
114
>
* Environment variable form of {@link AgentHostCodexAgentEnabledSettingId}.
115
>
* Set by the agent host starters from the setting. Accepts `'true'` /
116
>
* `'false'`; absent means "default" (`false`).
117
>
*/
118
>
export const AgentHostCodexAgentEnabledEnvVar = 'VSCODE_AGENT_HOST_CODEX_AGENT_ENABLED';
119
>
120
>
/**
121
>
* Environment variable form of {@link AgentHostByokModelsEnabledSettingId}.
122
>
* Set by the agent host starters from the setting. Accepts `'true'` /
123
>
* `'false'`; absent means "default" (`true`).
124
>
*/
125
>
export const AgentHostByokModelsEnabledEnvVar = 'VSCODE_AGENT_HOST_BYOK_MODELS_ENABLED';
126
>
127
>
/**
128
>
* Overrides the grace period (in milliseconds) before an idle, fully
129
>
* unsubscribed session is released from memory. Defaults to 30_000. Primarily a
130
>
* test hook so real-SDK integration tests can force a prompt release without
131
>
* waiting the full production grace; production does not set it.
132
>
*/
133
>
export const AgentHostSessionReleaseGraceMsEnvVar = 'VSCODE_AGENT_HOST_SESSION_RELEASE_GRACE_MS';
134
>
135
>
/**
136
>
* Resolves the effective enable state for a Claude/Codex provider from the
137
>
* env-var value forwarded by the starter. Recognized values (case- and
138
>
* whitespace-insensitive):
139
>
*
140
>
* - `'true'` / `'1'` → enabled
141
>
* - `'false'` / `'0'` → disabled
142
>
* - `undefined`, empty string, or any other value → falls through to
143
>
* {@link defaultEnabled}
144
>
*/
145
>
export function isAgentEnabled(envValue: string | undefined, defaultEnabled: boolean): boolean {
146
if (envValue === undefined || envValue === '') {
147
return defaultEnabled;