Merge pull request microsoft#210350 from microsoft/roblou/worried-termite

Chat API tweaks and /help fixes

Author: roblourens

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

@@ -405,7 +405,6 @@ class ExtHostChatAgent {
 	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;
 	private _onDidReceiveFeedback = new Emitter<vscode.ChatResultFeedback>();
 	private _onDidPerformAction = new Emitter<vscode.ChatUserActionEvent>();
@@ -510,7 +509,6 @@ class ExtHostChatAgent {
 					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,
 					requester: this._requester
 				});
@@ -598,13 +596,6 @@ class ExtHostChatAgent {
 				that._isSecondary = v;
 				updateMetadataSoon();
 			},
-			get sampleRequest() {
-				return that._sampleRequest;
-			},
-			set sampleRequest(v) {
-				that._sampleRequest = v;
-				updateMetadataSoon();
-			},
 			get supportIssueReporting() {
 				checkProposedApiEnabled(that.extension, 'chatParticipantAdditions');
 				return that._supportIssueReporting;

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

@@ -265,15 +265,18 @@ class ChatSlashStaticSlashCommandsContribution extends Disposable {
 			// Report agent list
 			const agentText = (await Promise.all(agents
 				.filter(a => a.id !== defaultAgent?.id)
+				.filter(a => a.locations.includes(ChatAgentLocation.Panel))
 				.map(async a => {
 					const agentWithLeader = `${chatAgentLeader}${a.name}`;
 					const actionArg: IChatExecuteActionContext = { inputValue: `${agentWithLeader} ${a.metadata.sampleRequest}` };
 					const urlSafeArg = encodeURIComponent(JSON.stringify(actionArg));
-					const agentLine = `* [\`${agentWithLeader}\`](command:${SubmitAction.ID}?${urlSafeArg}) - ${a.description}`;
+					const description = a.description ? `- ${a.description}` : '';
+					const agentLine = `* [\`${agentWithLeader}\`](command:${SubmitAction.ID}?${urlSafeArg}) ${description}`;
 					const commandText = a.slashCommands.map(c => {
 						const actionArg: IChatExecuteActionContext = { inputValue: `${agentWithLeader} ${chatSubcommandLeader}${c.name} ${c.sampleRequest ?? ''}` };
 						const urlSafeArg = encodeURIComponent(JSON.stringify(actionArg));
-						return `\t* [\`${chatSubcommandLeader}${c.name}\`](command:${SubmitAction.ID}?${urlSafeArg}) - ${c.description}`;
+						const description = c.description ? `- ${c.description}` : '';
+						return `\t* [\`${chatSubcommandLeader}${c.name}\`](command:${SubmitAction.ID}?${urlSafeArg}) ${description}`;
 					}).join('\n');
 
 					return (agentLine + '\n' + commandText).trim();

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

@@ -9,7 +9,6 @@ declare module 'vscode' {
 	 * Represents a user request in chat history.
 	 */
 	export class ChatRequestTurn {
-
 		/**
 		 * The prompt as entered by the user.
 		 *
@@ -21,7 +20,7 @@ declare module 'vscode' {
 		readonly prompt: string;
 
 		/**
-		 * The id of the chat participant and contributing extension to which this request was directed.
+		 * The id of the chat participant to which this request was directed.
 		 */
 		readonly participant: string;
 
@@ -32,6 +31,7 @@ declare module 'vscode' {
 
 		/**
 		 * The variables that were referenced in this message.
+		 * TODO@API ensure that this will be compatible with future changes to chat variables.
 		 */
 		readonly variables: ChatResolvedVariable[];
 
@@ -42,9 +42,8 @@ declare module 'vscode' {
 	 * Represents a chat participant's response in chat history.
 	 */
 	export class ChatResponseTurn {
-
 		/**
-		* The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.
+		 * The content that was received from the chat participant. Only the stream parts that represent actual content (not metadata) are represented.
 		 */
 		readonly response: ReadonlyArray<ChatResponseMarkdownPart | ChatResponseFileTreePart | ChatResponseAnchorPart | ChatResponseCommandButtonPart>;
 
@@ -54,7 +53,7 @@ declare module 'vscode' {
 		readonly result: ChatResult;
 
 		/**
-		 * The id of the chat participant and contributing extension that this response came from.
+		 * The id of the chat participant that this response came from.
 		 */
 		readonly participant: string;
 
@@ -132,8 +131,8 @@ declare module 'vscode' {
 	 */
 	export interface ChatResultFeedback {
 		/**
-		 * The ChatResult that the user is providing feedback for.
-		 * This instance has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
+		 * The ChatResult for which the user is providing feedback.
+		 * This object has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
 		 */
 		readonly result: ChatResult;
 
@@ -175,7 +174,7 @@ declare module 'vscode' {
 	export interface ChatFollowupProvider {
 		/**
 		 * Provide followups for the given result.
-		 * @param result This instance has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
+		 * @param result This object has the same properties as the result returned from the participant callback, including `metadata`, but is not the same instance.
 		 * @param token A cancellation token.
 		 */
 		provideFollowups(result: ChatResult, context: ChatContext, token: CancellationToken): ProviderResult<ChatFollowup[]>;
@@ -197,7 +196,7 @@ declare module 'vscode' {
 		readonly id: string;
 
 		/**
-		 * Icon for the participant shown in UI.
+		 * An icon for the participant shown in UI.
 		 */
 		iconPath?: Uri | {
 			/**
@@ -220,11 +219,6 @@ declare module 'vscode' {
 		 */
 		followupProvider?: ChatFollowupProvider;
 
-		/**
-		 * When the user clicks this participant in `/help`, this text will be submitted to this participant.
-		 */
-		sampleRequest?: string;
-
 		/**
 		 * An event that fires whenever feedback for a result is received, e.g. when a user up- or down-votes
 		 * a result.
@@ -293,9 +287,7 @@ declare module 'vscode' {
 		 * in the prompt. That means the last variable in the prompt is the first in this list. This simplifies
 		 * string-manipulation of the prompt.
 		 */
-		// TODO@API Q? are there implicit variables that are not part of the prompt?
 		readonly variables: readonly ChatResolvedVariable[];
-
 	}
 
 	/**
@@ -373,8 +365,11 @@ declare module 'vscode' {
 	}
 
 	export class ChatResponseMarkdownPart {
-		/** Note: The boolean form of {@link MarkdownString.isTrusted} is NOT supported. */
 		value: MarkdownString;
+
+		/**
+		 * @param value Note: The boolean form of {@link MarkdownString.isTrusted} is NOT supported.
+		 */
 		constructor(value: string | MarkdownString);
 	}