Show variables in help text (microsoft#205553)

Author: roblourens

src/vs/workbench/api/common/extHostChatAgents2.ts

@@ -340,6 +340,7 @@ class ExtHostChatAgent {
 	private _iconPath: vscode.Uri | { light: vscode.Uri; dark: vscode.Uri } | vscode.ThemeIcon | undefined;
 	private _isDefault: boolean | undefined;
 	private _helpTextPrefix: string | vscode.MarkdownString | undefined;
+	private _helpTextVariablesPrefix: string | vscode.MarkdownString | undefined;
 	private _helpTextPostfix: string | vscode.MarkdownString | undefined;
 	private _sampleRequest?: string;
 	private _isSecondary: boolean | undefined;
@@ -470,6 +471,7 @@ class ExtHostChatAgent {
 					isDefault: this._isDefault,
 					isSecondary: this._isSecondary,
 					helpTextPrefix: (!this._helpTextPrefix || typeof this._helpTextPrefix === 'string') ? this._helpTextPrefix : typeConvert.MarkdownString.from(this._helpTextPrefix),
+					helpTextVariablesPrefix: (!this._helpTextVariablesPrefix || typeof this._helpTextVariablesPrefix === 'string') ? this._helpTextVariablesPrefix : typeConvert.MarkdownString.from(this._helpTextVariablesPrefix),
 					helpTextPostfix: (!this._helpTextPostfix || typeof this._helpTextPostfix === 'string') ? this._helpTextPostfix : typeConvert.MarkdownString.from(this._helpTextPostfix),
 					sampleRequest: this._sampleRequest,
 					supportIssueReporting: this._supportIssueReporting,
@@ -548,6 +550,19 @@ class ExtHostChatAgent {
 				that._helpTextPrefix = v;
 				updateMetadataSoon();
 			},
+			get helpTextVariablesPrefix() {
+				checkProposedApiEnabled(that.extension, 'defaultChatParticipant');
+				return that._helpTextVariablesPrefix;
+			},
+			set helpTextVariablesPrefix(v) {
+				checkProposedApiEnabled(that.extension, 'defaultChatParticipant');
+				if (!that._isDefault) {
+					throw new Error('helpTextVariablesPrefix is only available on the default chat agent');
+				}
+
+				that._helpTextVariablesPrefix = v;
+				updateMetadataSoon();
+			},
 			get helpTextPostfix() {
 				checkProposedApiEnabled(that.extension, 'defaultChatParticipant');
 				return that._helpTextPostfix;

src/vs/workbench/contrib/chat/browser/chat.contribution.ts

@@ -56,7 +56,7 @@ import { registerChatFileTreeActions } from 'vs/workbench/contrib/chat/browser/a
 import { QuickChatService } from 'vs/workbench/contrib/chat/browser/chatQuick';
 import { ChatAgentService, IChatAgentService } from 'vs/workbench/contrib/chat/common/chatAgents';
 import { ChatVariablesService } from 'vs/workbench/contrib/chat/browser/chatVariables';
-import { chatAgentLeader, chatSubcommandLeader } from 'vs/workbench/contrib/chat/common/chatParserTypes';
+import { chatAgentLeader, chatSubcommandLeader, chatVariableLeader } from 'vs/workbench/contrib/chat/common/chatParserTypes';
 import { CancellationToken } from 'vs/base/common/cancellation';
 import { IVoiceChatService, VoiceChatService } from 'vs/workbench/contrib/chat/common/voiceChat';
 
@@ -228,6 +228,7 @@ class ChatSlashStaticSlashCommandsContribution extends Disposable {
 		@IChatSlashCommandService slashCommandService: IChatSlashCommandService,
 		@ICommandService commandService: ICommandService,
 		@IChatAgentService chatAgentService: IChatAgentService,
+		@IChatVariablesService chatVariablesService: IChatVariablesService,
 	) {
 		super();
 		this._store.add(slashCommandService.registerSlashCommand({
@@ -246,6 +247,8 @@ class ChatSlashStaticSlashCommandsContribution extends Disposable {
 		}, async (prompt, progress) => {
 			const defaultAgent = chatAgentService.getDefaultAgent();
 			const agents = chatAgentService.getAgents();
+
+			// Report prefix
 			if (defaultAgent?.metadata.helpTextPrefix) {
 				if (isMarkdownString(defaultAgent.metadata.helpTextPrefix)) {
 					progress.report({ content: defaultAgent.metadata.helpTextPrefix, kind: 'markdownContent' });
@@ -255,6 +258,7 @@ class ChatSlashStaticSlashCommandsContribution extends Disposable {
 				progress.report({ content: '\n\n', kind: 'content' });
 			}
 
+			// Report agent list
 			const agentText = (await Promise.all(agents
 				.filter(a => a.id !== defaultAgent?.id)
 				.map(async a => {
@@ -272,6 +276,23 @@ class ChatSlashStaticSlashCommandsContribution extends Disposable {
 					return (agentLine + '\n' + commandText).trim();
 				}))).join('\n');
 			progress.report({ content: new MarkdownString(agentText, { isTrusted: { enabledCommands: [SubmitAction.ID] } }), kind: 'markdownContent' });
+
+			// Report variables
+			if (defaultAgent?.metadata.helpTextVariablesPrefix) {
+				progress.report({ content: '\n\n', kind: 'content' });
+				if (isMarkdownString(defaultAgent.metadata.helpTextVariablesPrefix)) {
+					progress.report({ content: defaultAgent.metadata.helpTextVariablesPrefix, kind: 'markdownContent' });
+				} else {
+					progress.report({ content: defaultAgent.metadata.helpTextVariablesPrefix, kind: 'content' });
+				}
+
+				const variableText = Array.from(chatVariablesService.getVariables())
+					.map(v => `* \`${chatVariableLeader}${v.name}\` - ${v.description}`)
+					.join('\n');
+				progress.report({ content: '\n' + variableText, kind: 'content' });
+			}
+
+			// Report help text ending
 			if (defaultAgent?.metadata.helpTextPostfix) {
 				progress.report({ content: '\n\n', kind: 'content' });
 				if (isMarkdownString(defaultAgent.metadata.helpTextPostfix)) {

src/vs/workbench/contrib/chat/common/chatAgents.ts

@@ -70,6 +70,7 @@ export interface IChatAgentMetadata {
 	description?: string;
 	isDefault?: boolean; // The agent invoked when no agent is specified
 	helpTextPrefix?: string | IMarkdownString;
+	helpTextVariablesPrefix?: string | IMarkdownString;
 	helpTextPostfix?: string | IMarkdownString;
 	isSecondary?: boolean; // Invoked by ctrl/cmd+enter
 	fullName?: string;

src/vscode-dts/vscode.proposed.defaultChatParticipant.d.ts

@@ -29,6 +29,11 @@ declare module 'vscode' {
 		 */
 		helpTextPrefix?: string | MarkdownString;
 
+		/**
+		 * A string that will be added before the listing of chat variables in `/help`.
+		 */
+		helpTextVariablesPrefix?: string | MarkdownString;
+
 		/**
 		 * A string that will be appended after the listing of chat participants in `/help`.
 		 */