src/vs/platform/agentHost/common/agentHostCustomizationConfig.ts
152 LOC · 138 covered · 14 uncovered · 2 ranges · 3039 concepts · 1 introducers · 1442 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
agentConfigurationService.ts ×16
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 { localize } from '../../../nls.js';
7
>
import { createSchema, schemaProperty } from './agentHostSchema.js';
8
>
import { CustomizationType, type Customization, type PluginCustomization } from './state/protocol/state.js';
9
>
import { customizationId } from './state/sessionState.js';
10
>
11
>
export const codexUsageSources = ['copilot', 'openai'] as const;
12
>
export type CodexUsageSource = typeof codexUsageSources[number];
13
>
14
>
/**
15
>
* Well-known root-config keys used by the platform to configure agent-host
16
>
* customizations.
17
>
*/
18
>
export const enum AgentHostConfigKey {
19
>
/** Host-owned Open Plugins available to remote sessions. */
20
>
Customizations = 'customizations',
21
>
/**
22
>
* Absolute path to the shell executable for host-managed terminals.
23
>
* TODO: revisit magic key in config; refine into a dedicated typed channel. https://github.com/microsoft/vscode/issues/313812
24
>
*/
25
>
DefaultShell = 'defaultShell',
26
>
/**
27
>
* When true (the default), the Claude provider routes all Anthropic
28
>
* `messages` traffic through the local Copilot-CAPI proxy (Copilot-routed
29
>
* Claude). When false, the Claude Agent SDK talks to Anthropic directly on
30
>
* the user's own credentials (BYO Anthropic — Phase 19).
31
>
*/
32
>
ClaudeUseCopilotProxy = 'claudeUseCopilotProxy',
33
>
CodexUsageSource = 'codexUsageSource',
34
>
/** Controls whether session-scoped file customizations come from local scan or SDK discovery. */
35
>
SessionCustomizationDiscoveryMode = 'sessionCustomizationDiscoveryMode',
36
>
/**
37
>
* Optional GitHub Enterprise base URI (e.g. `https://ghe.example.com` for a
38
>
* GitHub Enterprise Server, or `https://tenant.ghe.com` for GitHub Enterprise
39
>
* Cloud). When set, the agent host computes its GitHub protected resources and
40
>
* REST/GraphQL endpoints from this base instead of github.com. Normally pushed
41
>
* by the local VS Code client from the workbench `github-enterprise.uri`
42
>
* setting; remote operators set it directly in the remote
43
>
* `agent-host-config.json`.
44
>
*/
45
>
GithubEnterpriseUri = 'githubEnterpriseUri',
46
>
}
47
>
48
>
export const SESSION_CUSTOMIZATION_DISCOVERY_MODES = ['scan', 'discover'] as const;
49
>
export type SessionCustomizationDiscoveryMode = typeof SESSION_CUSTOMIZATION_DISCOVERY_MODES[number];
50
>
export const DEFAULT_SESSION_CUSTOMIZATION_DISCOVERY_MODE: SessionCustomizationDiscoveryMode = 'scan';
51
>
52
>
/**
53
>
* Persisted on-disk shape for a host-configured plugin. Kept stable across
54
>
* the customization protocol refactor so existing `agent-host-config.json`
55
>
* files keep working; entries are mapped to the new
56
>
* {@link Customization} shape at read time by
57
>
* {@link getAgentHostConfiguredCustomizations}.
58
>
*/
59
>
interface IPersistedCustomizationConfigEntry {
60
>
uri: string;
61
>
displayName: string;
62
>
description?: string;
63
>
}
64
>
65
>
export const agentHostCustomizationConfigSchema = createSchema({
66
>
[AgentHostConfigKey.Customizations]: schemaProperty<IPersistedCustomizationConfigEntry[]>({
67
>
type: 'array',
68
>
title: localize('agentHost.config.customizations.title', "Plugins"),
69
>
description: localize('agentHost.config.customizations.description', "Plugins configured on this agent host and available to remote sessions."),
70
>
default: [],
71
>
items: {
72
>
type: 'object',
73
>
title: localize('agentHost.config.customizations.itemTitle', "Plugin"),
74
>
properties: {
75
>
uri: {
76
>
type: 'string',
77
>
title: localize('agentHost.config.customizations.uri', "Plugin URI"),
78
>
},
79
>
displayName: {
80
>
type: 'string',
81
>
title: localize('agentHost.config.customizations.displayName', "Name"),
82
>
},
83
>
description: {
84
>
type: 'string',
85
>
title: localize('agentHost.config.customizations.descriptionField', "Description"),
86
>
},
87
>
},
88
>
required: ['uri', 'displayName'],
89
>
},
90
>
}),
91
>
[AgentHostConfigKey.DefaultShell]: schemaProperty<string>({
92
>
type: 'string',
93
>
title: localize('agentHost.config.defaultShell.title', "Default Shell"),
94
>
description: localize('agentHost.config.defaultShell.description', "Absolute path to the shell executable used by host-managed terminals. Normally pushed by the connected VS Code client from `terminal.integrated.agentHostProfile.<os>` (falling back to `terminal.integrated.defaultProfile.<os>`); when unset, the agent host falls back to the system shell. Only the path is supported; `args` and `env` from the workbench profile are not piped through yet. The workbench only pushes this for the local agent host — remote agent host operators should set this directly in the remote machine's `agent-host-config.json`."),
95
>
}),
96
>
[AgentHostConfigKey.ClaudeUseCopilotProxy]: schemaProperty<boolean>({
97
>
type: 'boolean',
98
>
title: localize('agentHost.config.claudeUseCopilotProxy.title', "Route Claude Through Copilot"),
99
>
description: localize('agentHost.config.claudeUseCopilotProxy.description', "When enabled (the default), the Claude agent routes all requests through GitHub Copilot. When disabled, Claude talks to Anthropic directly using your own credentials (API key or Claude subscription)."),
100
>
default: true,
101
>
}),
102
>
[AgentHostConfigKey.CodexUsageSource]: schemaProperty<CodexUsageSource>({
103
>
type: 'string',
104
>
title: localize('agentHost.config.codexUsageSource.title', "Codex Usage Source"),
105
>
description: localize('agentHost.config.codexUsageSource.description', "Choose whether Codex usage is routed through GitHub Copilot or uses an existing Codex OpenAI login. VS Code does not provide the OpenAI sign-in flow; authenticate Codex separately before selecting OpenAI."),
106
>
default: 'copilot',
107
>
enum: [...codexUsageSources],
108
>
}),
109
>
[AgentHostConfigKey.SessionCustomizationDiscoveryMode]: schemaProperty<SessionCustomizationDiscoveryMode>({
110
>
type: 'string',
111
>
enum: [...SESSION_CUSTOMIZATION_DISCOVERY_MODES],
112
>
title: localize('agentHost.config.sessionCustomizationDiscoveryMode.title', "Session Customization Discovery Mode"),
113
>
description: localize('agentHost.config.sessionCustomizationDiscoveryMode.description', "Controls whether session-scoped customizations are populated from local file scanning or from Copilot SDK discovery."),
114
>
default: DEFAULT_SESSION_CUSTOMIZATION_DISCOVERY_MODE,
115
>
}),
116
>
[AgentHostConfigKey.GithubEnterpriseUri]: schemaProperty<string>({
117
>
type: 'string',
118
>
title: localize('agentHost.config.githubEnterpriseUri.title', "GitHub Enterprise URI"),
119
>
description: localize('agentHost.config.githubEnterpriseUri.description', "Optional base URI of a GitHub Enterprise instance (for example \"https://ghe.example.com\" for GitHub Enterprise Server, or \"https://tenant.ghe.com\" for GitHub Enterprise Cloud). When set, the agent host authenticates and makes GitHub API calls against this instance instead of github.com. Normally pushed by the connected VS Code client from the `github-enterprise.uri` setting; remote agent host operators can set it directly in the remote `agent-host-config.json`."),
120
>
}),
121
>
});
122
>
123
>
export const defaultAgentHostCustomizationConfigValues = {
124
>
[AgentHostConfigKey.Customizations]: [] as IPersistedCustomizationConfigEntry[],
125
>
};
126
>
127
>
/**
128
>
* Reads the persisted (legacy-shaped) plugin entries from the agent-host
129
>
* root config and lifts them into the new {@link Customization} container
130
>
* shape used by the rest of the platform.
131
>
*/
132
>
export function getAgentHostConfiguredCustomizations(values: Record<string, unknown> | undefined): readonly Customization[] {
133
const raw = values?.[AgentHostConfigKey.Customizations];
134
const entries = agentHostCustomizationConfigSchema.validate(AgentHostConfigKey.Customizations, raw)
135
? raw
136
: defaultAgentHostCustomizationConfigValues[AgentHostConfigKey.Customizations];
137
return entries.map(toContainerCustomization);
138
}
140
>
/**
141
>
* Lifts a persisted plugin config entry into the new
142
>
* {@link Customization} container shape.
143
>
*/
144
>
export function toContainerCustomization(entry: IPersistedCustomizationConfigEntry): PluginCustomization {
145
return {
146
type: CustomizationType.Plugin,
147
id: customizationId(entry.uri),
148
uri: entry.uri,
149
name: entry.displayName,
150
enabled: true,
151
};
152
}