Add customInstructionsInSystemMessage setting (#257)

* Add customInstructionsInSystemMessage setting
Fix microsoft/vscode#255859

* Add test for CustomInstructionsInSystemMessage

* Add OmitBaseAgentInstructions setting

* Don't include the 'when generating code' message

Author: roblourens

package.json

@@ -2813,6 +2813,14 @@
 						],
 						"description": "%github.copilot.config.agent.currentEditorContext.enabled%"
 					},
+					"github.copilot.chat.customInstructionsInSystemMessage": {
+						"type": "boolean",
+						"default": false,
+						"tags": [
+							"experimental"
+						],
+						"description": "%github.copilot.config.customInstructionsInSystemMessage%"
+					},
 					"github.copilot.chat.agent.terminal.allowList": {
 						"type": "object",
 						"default": {},

package.nls.json

@@ -280,6 +280,7 @@
 	"copilot.tools.getDocInfo.name": "Doc Info",
 	"copilot.tools.createDirectory.name": "Create Directory",
 	"github.copilot.config.agent.currentEditorContext.enabled": "When enabled, Copilot will include the name of the current active editor in the context for agent mode.",
+	"github.copilot.config.customInstructionsInSystemMessage": "When enabled, custom instructions and mode instructions will be appended to the system message instead of a user message.",
 	"github.copilot.config.agent.terminal.allowList": "A list of commands or regular expressions that allow the run in terminal tool commands to run without explicit approval. These will be matched against the start of a command. A regular expression can be provided by wrapping the string in `/` characters.\n\nExamples:\n- `\"mkdir\"` Will allow all command lines starting with `mkdir`\n- `\"npm run build\"` Will allow all command lines starting with `npm run build`\n- `\"/^git (status|show\\b.*)$/\"` will allow `git status` and all command lines starting with `git show`\n- `\"/.*/\"` will allow all command lines\n\nThis will be overridden by anything that matches an entry in `#github.copilot.config.agent.terminal.denyList#`.",
 	"github.copilot.config.agent.terminal.allowList.key": "The start of a command to match against. A regular expression can be provided by wrapping the string in `/` characters.",
 	"github.copilot.config.agent.terminal.allowList.value.true": "Allow the pattern.",

src/extension/prompts/node/agent/agentPrompt.tsx

@@ -90,21 +90,18 @@ export class AgentPrompt extends PromptElement<AgentPromptProps> {
 				codesearchMode={this.props.codesearchMode}
 			/>;
 
-		const baseInstructions = <>
+		const omitBaseAgentInstructions = this.configurationService.getConfig(ConfigKey.Internal.OmitBaseAgentInstructions);
+		const baseAgentInstructions = <>
 			<SystemMessage>
 				You are an expert AI programming assistant, working with a user in the VS Code editor.<br />
 				<CopilotIdentityRules />
 				<SafetyRules />
 			</SystemMessage>
 			{instructions}
-			<UserMessage>
-				<CustomInstructions languageId={undefined} chatVariables={this.props.promptContext.chatVariables} />
-				{this.props.promptContext.modeInstructions && <Tag name='customInstructions'>
-					Below are some additional instructions from the user.<br />
-					<br />
-					{this.props.promptContext.modeInstructions}
-				</Tag>}
-			</UserMessage>
+		</>;
+		const baseInstructions = <>
+			{!omitBaseAgentInstructions && baseAgentInstructions}
+			{this.getAgentCustomInstructions()}
 			<UserMessage>
 				{await this.getOrCreateGlobalAgentContext(this.props.endpoint)}
 			</UserMessage>
@@ -137,6 +134,28 @@ export class AgentPrompt extends PromptElement<AgentPromptProps> {
 		}
 	}
 
+	private getAgentCustomInstructions() {
+		const putCustomInstructionsInSystemMessage = this.configurationService.getConfig(ConfigKey.CustomInstructionsInSystemMessage);
+		const customInstructionsBody = <>
+			<CustomInstructions
+				languageId={undefined}
+				chatVariables={this.props.promptContext.chatVariables}
+				includeSystemMessageConflictWarning={!putCustomInstructionsInSystemMessage}
+				customIntroduction={putCustomInstructionsInSystemMessage ? '' : undefined} // If in system message, skip the "follow these user-provided coding instructions" intro
+			/>
+			{
+				this.props.promptContext.modeInstructions && <Tag name='customInstructions'>
+					Below are some additional instructions from the user.<br />
+					<br />
+					{this.props.promptContext.modeInstructions}
+				</Tag>
+			}
+		</>;
+		return putCustomInstructionsInSystemMessage ?
+			<SystemMessage>{customInstructionsBody}</SystemMessage> :
+			<UserMessage>{customInstructionsBody}</UserMessage>;
+	}
+
 	private async getOrCreateGlobalAgentContext(endpoint: IChatEndpoint): Promise<PromptPieceChild[]> {
 		const globalContext = await this.getOrCreateGlobalAgentContextContent(endpoint);
 		return globalContext ?

src/extension/prompts/node/agent/test/__snapshots__/agentPrompt.spec.tsx.snap

@@ -595,6 +595,141 @@ copilot_cache_control: {"type":"ephemeral"}
 "
 `;
 
+exports[`AgentPrompt > custom instructions in system message 1`] = `
+"### System
+~~~md
+You are an expert AI programming assistant, working with a user in the VS Code editor.
+When asked for your name, you must respond with "GitHub Copilot".
+Follow the user's requirements carefully & to the letter.
+Follow Microsoft content policies.
+Avoid content that violates copyrights.
+If you are asked to generate content that is harmful, hateful, racist, sexist, lewd, or violent, only respond with "Sorry, I can't assist with that."
+Keep your answers short and impersonal.
+<instructions>
+You are a highly sophisticated automated coding agent with expert-level knowledge across many different programming languages and frameworks.
+The user will ask a question, or ask you to perform a task, and it may require lots of research to answer correctly. There is a selection of tools that let you perform actions or retrieve helpful context to answer the user's question.
+You will be given some context and attachments along with the user prompt. You can use them if they are relevant to the task, and ignore them if not.
+If you can infer the project type (languages, frameworks, and libraries) from the user's query or the context that you have, make sure to keep them in mind when making changes.
+If the user wants you to implement a feature and they have not specified the files to edit, first break down the user's request into smaller concepts and think about the kinds of files you need to grasp each concept.
+If you aren't sure which tool is relevant, you can call multiple tools. You can call tools repeatedly to take actions or gather as much context as needed until you have completed the task fully. Don't give up unless you are sure the request cannot be fulfilled with the tools you have. It's YOUR RESPONSIBILITY to make sure that you have done all you can to collect necessary context.
+When reading files, prefer reading large meaningful chunks rather than consecutive small sections to minimize tool calls and gain better context.
+Don't make assumptions about the situation- gather context first, then perform the task or answer the question.
+Think creatively and explore the workspace in order to make a complete fix.
+Don't repeat yourself after a tool call, pick up where you left off.
+You don't need to read a file if it's already provided in context.
+</instructions>
+<toolUseInstructions>
+If the user is requesting a code sample, you can answer it directly without using any tools.
+When using a tool, follow the JSON schema very carefully and make sure to include ALL required properties.
+No need to ask permission before using a tool.
+NEVER say the name of a tool to a user. For example, instead of saying that you'll use the run_in_terminal tool, say "I'll run the command in a terminal".
+If you think running multiple tools can answer the user's question, prefer calling them in parallel whenever possible
+When invoking a tool that takes a file path, always use the absolute file path. If the file has a scheme like untitled: or vscode-userdata:, then use a URI with the scheme.
+You don't currently have any tools available for editing files. If the user asks you to edit a file, you can ask the user to enable editing tools or print a codeblock with the suggested changes.
+You don't currently have any tools available for running terminal commands. If the user asks you to run a terminal command, you can ask the user to enable terminal tools or print a codeblock with the suggested command.
+Tools can be disabled by the user. You may see tools used previously in the conversation that are not currently available. Be careful to only use the tools that are currently available to you.
+</toolUseInstructions>
+<outputFormatting>
+Use proper Markdown formatting in your answers. When referring to a filename or symbol in the user's workspace, wrap it in backticks.
+<example>
+The class \`Person\` is in \`src/models/person.ts\`.
+</example>
+
+</outputFormatting>
+
+<instructions>
+This is a test custom instruction file
+</instructions>
+<customInstructions>
+Below are some additional instructions from the user.
+
+custom mode instructions
+</customInstructions>
+copilot_cache_control: {"type":"ephemeral"}
+~~~
+
+
+### User
+~~~md
+<environment_info>
+The user's current OS is: Linux
+The user's default shell is: "zsh". When you generate terminal commands, please generate them correctly for this shell.
+</environment_info>
+<workspace_info>
+I am working in a workspace with the following folders:
+- /workspace 
+I am working in a workspace that has the following structure:
+\`\`\`
+
+\`\`\`
+This is the state of the context at this point in the conversation. The view of the workspace structure may be truncated. You can use tools to collect more context if needed.
+</workspace_info>
+copilot_cache_control: {"type":"ephemeral"}
+~~~
+
+
+### User
+~~~md
+<context>
+(Date removed from snapshot)
+</context>
+<reminderInstructions>
+
+</reminderInstructions>
+<userRequest>
+hello
+</userRequest>
+copilot_cache_control: {"type":"ephemeral"}
+~~~
+"
+`;
+
+exports[`AgentPrompt > omit base agent instructions 1`] = `
+"### System
+~~~md
+
+<instructions>
+This is a test custom instruction file
+</instructions>
+copilot_cache_control: {"type":"ephemeral"}
+~~~
+
+
+### User
+~~~md
+<environment_info>
+The user's current OS is: Linux
+The user's default shell is: "zsh". When you generate terminal commands, please generate them correctly for this shell.
+</environment_info>
+<workspace_info>
+I am working in a workspace with the following folders:
+- /workspace 
+I am working in a workspace that has the following structure:
+\`\`\`
+
+\`\`\`
+This is the state of the context at this point in the conversation. The view of the workspace structure may be truncated. You can use tools to collect more context if needed.
+</workspace_info>
+copilot_cache_control: {"type":"ephemeral"}
+~~~
+
+
+### User
+~~~md
+<context>
+(Date removed from snapshot)
+</context>
+<reminderInstructions>
+
+</reminderInstructions>
+<userRequest>
+hello
+</userRequest>
+copilot_cache_control: {"type":"ephemeral"}
+~~~
+"
+`;
+
 exports[`AgentPrompt > one attachment 1`] = `
 "### System
 ~~~md

src/extension/prompts/node/agent/test/agentPrompt.spec.tsx

@@ -111,7 +111,6 @@ suite('AgentPrompt', () => {
 		return result;
 	}
 
-
 	test('simple case', async () => {
 		expect(await agentPromptToString(accessor, {
 			chatVariables: new ChatVariablesCollection(),
@@ -233,4 +232,23 @@ suite('AgentPrompt', () => {
 				enableCacheBreakpoints: true,
 			})).toMatchSnapshot();
 	});
+
+	test('custom instructions in system message', async () => {
+		accessor.get(IConfigurationService).setConfig(ConfigKey.CustomInstructionsInSystemMessage, true);
+		expect(await agentPromptToString(accessor, {
+			chatVariables: new ChatVariablesCollection(),
+			history: [],
+			query: 'hello',
+			modeInstructions: 'custom mode instructions',
+		}, undefined)).toMatchSnapshot();
+	});
+
+	test('omit base agent instructions', async () => {
+		accessor.get(IConfigurationService).setConfig(ConfigKey.Internal.OmitBaseAgentInstructions, true);
+		expect(await agentPromptToString(accessor, {
+			chatVariables: new ChatVariablesCollection(),
+			history: [],
+			query: 'hello',
+		}, undefined)).toMatchSnapshot();
+	});
 });

src/extension/prompts/node/panel/customInstructions.tsx

@@ -37,6 +37,11 @@ export interface CustomInstructionsProps extends BasePromptElementProps {
 	 */
 	readonly includePullRequestDescriptionGenerationInstructions?: boolean;
 	readonly customIntroduction?: string;
+
+	/**
+	 * @default true
+	 */
+	readonly includeSystemMessageConflictWarning?: boolean;
 }
 
 export class CustomInstructions extends PromptElement<CustomInstructionsProps> {
@@ -50,6 +55,7 @@ export class CustomInstructions extends PromptElement<CustomInstructionsProps> {
 	override async render(state: void, sizing: PromptSizing) {
 
 		const { includeCodeGenerationInstructions, includeTestGenerationInstructions, includeCodeFeedbackInstructions, includeCommitMessageGenerationInstructions, includePullRequestDescriptionGenerationInstructions, customIntroduction } = this.props;
+		const includeSystemMessageConflictWarning = this.props.includeSystemMessageConflictWarning ?? true;
 
 		const chunks = [];
 
@@ -97,9 +103,10 @@ export class CustomInstructions extends PromptElement<CustomInstructionsProps> {
 			return undefined;
 		}
 		const introduction = customIntroduction ?? 'When generating code, please follow these user provided coding instructions.';
+		const systemMessageConflictWarning = includeSystemMessageConflictWarning && ' You can ignore an instruction if it contradicts a system message.';
 
 		return (<>
-			{introduction} You can ignore an instruction if it contradicts a system message.<br />
+			{introduction}{systemMessageConflictWarning}<br />
 			<Tag name='instructions'>
 				{
 					...chunks

src/platform/configuration/common/configurationService.ts

@@ -711,6 +711,7 @@ export namespace ConfigKey {
 		export const AskAgent = defineExpSetting<boolean>('chat.advanced.enableAskAgent', { defaultValue: false, teamDefaultValue: true, internalDefaultValue: true }, INTERNAL_RESTRICTED);
 		export const VerifyTextDocumentChanges = defineExpSetting<boolean>('chat.advanced.inlineEdits.verifyTextDocumentChanges', true, INTERNAL_RESTRICTED);
 		export const EnableApplyPatchForNotebooks = defineExpSetting<boolean>('chat.advanced.enableApplyPatchForNotebooks', false, INTERNAL_RESTRICTED);
+		export const OmitBaseAgentInstructions = defineSetting<boolean>('chat.advanced.omitBaseAgentInstructions', false, INTERNAL);
 	}
 
 	export const AgentThinkingTool = defineSetting<boolean>('chat.agent.thinkingTool', false);
@@ -773,6 +774,7 @@ export namespace ConfigKey {
 	export const EditsCodeNewNotebookAgentEnabled = defineExpSetting<boolean>('chat.edits.newNotebook.enabled', true);
 	export const AutoFixDiagnostics = defineSetting<boolean>('chat.agent.autoFix', true);
 	export const NotebookFollowCellExecution = defineSetting<boolean>('chat.notebook.followCellExecution.enabled', false);
+	export const CustomInstructionsInSystemMessage = defineSetting<boolean>('chat.customInstructionsInSystemMessage', false);
 }
 
 export function getAllConfigKeys(): string[] {