feat: add include_coder_system_prompt variable

Author: ssncferreira

registry/coder/modules/claude-code/README.md

@@ -26,6 +26,11 @@ module "claude-code" {
 > [!NOTE]
 > By default, this module is configured to run the embedded chat interface as a path-based application. In production, we recommend that you configure a [wildcard access URL](https://coder.com/docs/admin/setup#wildcard-access-url) and set `subdomain = true`. See [here](https://coder.com/docs/tutorials/best-practices/security-best-practices#disable-path-based-apps) for more details.
 
+<!-- TODO(major): remove this note and update the prompt configuration example in the next major release -->
+> [!NOTE]
+> By default, `include_coder_system_prompt` is false. For proper integration with Coder (tool selection & task reporting), 
+it is recommended to set `include_coder_system_prompt` to true. In the next major release, this will become the default.
+
 ## Prerequisites
 
 - An **Anthropic API key** or a _Claude Session Token_ is required for tasks.
@@ -34,6 +39,26 @@ module "claude-code" {
 
 ## Examples
 
+### Prompt configuration (recommended)
+
+Include Coder’s prompt sections and optionally add your own system prompt.
+
+```hcl
+module "claude-code" {
+  source   = "registry.coder.com/coder/claude-code/coder"
+  version  = "3.1.0"
+  agent_id = coder_agent.example.id
+  workdir  = "/home/coder/project"
+
+  include_coder_system_prompt = true
+  
+  # Optional: append additional system prompt.
+  system_prompt = <<-EOT
+    Additional organization-specific guidance here.
+  EOT
+}
+```
+
 ### Usage with Tasks and Advanced Configuration
 
 This example shows how to configure the Claude Code module with an AI prompt, API key shared by all users of the template, and other custom settings.

registry/coder/modules/claude-code/main.tf

@@ -182,8 +182,15 @@ variable "claude_code_oauth_token" {
 
 variable "system_prompt" {
   type        = string
-  description = "The additional system prompt to use for the Claude Code server. The module includes mandatory sections inside a <system> block. Leave empty to include only the mandatory sections."
-  default     = ""
+  description = "The system prompt to use for the Claude Code server."
+  default     = "Send a task status update to notify the user that you are ready for input, and then wait for user input."
+}
+
+variable "include_coder_system_prompt" {
+  type        = bool
+  description = "Include Coder system prompts for proper integration with tool selection and task reporting."
+  # TODO(major): default to true in the next major release
+  default     = false
 }
 
 variable "claude_md_path" {
@@ -230,7 +237,7 @@ locals {
   module_dir_name                   = ".claude-module"
   remove_last_session_id_script_b64 = base64encode(file("${path.module}/scripts/remove-last-session-id.sh"))
 
-  # Required prompts for the module to properly integrate with coder
+  # Required prompts for the module to properly integrate with Coder
   inner_system_prompt = <<-EOT
       -- Tool Selection --
       - coder_report_task: providing status updates or requesting user input.
@@ -258,13 +265,13 @@ locals {
       details, or encounter blockers
     EOT
 
-  user_system_prompt = trimspace(try(var.system_prompt, ""))
+  custom_system_prompt = trimspace(try(var.system_prompt, ""))
 
-  final_system_prompt = format(
+  final_system_prompt = var.include_coder_system_prompt ? format(
     "<system>\n%s\n%s\n</system>",
     local.inner_system_prompt,
-    local.user_system_prompt
-  )
+    local.custom_system_prompt,
+  ) : local.custom_system_prompt
 }
 
 module "agentapi" {

registry/coder/modules/claude-code/main.tftest.hcl

@@ -188,28 +188,30 @@ run "test_claude_code_permission_mode_validation" {
   }
 }
 
-run "test_claude_code_system_prompt_omit" {
+run "test_claude_code_system_prompt_default" {
   command = plan
 
   variables {
     agent_id = "test-agent-system-prompt"
     workdir  = "/home/coder/test"
-    # system_prompt omitted: default string is used
+    # system_prompt: default string is used
+    # include_coder_system_prompt: default is false
   }
 
   assert {
     condition     = trimspace(coder_env.claude_code_system_prompt.value) != ""
-    error_message = "System prompt must not be empty when omitted"
+    error_message = "System prompt should not be empty when omitted"
   }
 
   assert {
-    condition     = length(regexall("-- Tool Selection --", coder_env.claude_code_system_prompt.value)) > 0
-    error_message = "Mandatory Tool Selection section missing"
+    condition     = length(regexall("Send a task status update to notify the user that you are ready for input, and then wait for user input.", coder_env.claude_code_system_prompt.value)) > 0
+    error_message = "System prompt should have default value"
   }
 
+  # Ensure Coder sections are not injected when include=false
   assert {
-    condition     = length(regexall("-- Task Reporting --", coder_env.claude_code_system_prompt.value)) > 0
-    error_message = "Mandatory Task Reporting section missing"
+    condition     = length(regexall("-- Tool Selection --|-- Task Reporting --", coder_env.claude_code_system_prompt.value)) == 0
+    error_message = "Coder integration sections should not be present when include_coder_system_prompt is false"
   }
 }
 
@@ -220,45 +222,100 @@ run "test_claude_code_system_prompt_empty" {
     agent_id      = "test-agent-system-prompt"
     workdir       = "/home/coder/test"
     system_prompt = ""
+    # include_coder_system_prompt: default is false
+  }
+
+  assert {
+    condition     = trimspace(coder_env.claude_code_system_prompt.value) == ""
+    error_message = "System prompt should be empty"
+  }
+}
+
+run "test_claude_code_system_prompt" {
+  command = plan
+
+  variables {
+    agent_id      = "test-agent-system-prompt"
+    workdir       = "/home/coder/test"
+    system_prompt = "Custom addition"
+    # include_coder_system_prompt: default is false
   }
 
   assert {
     condition     = trimspace(coder_env.claude_code_system_prompt.value) != ""
-    error_message = "System prompt must not be empty when omitted"
+    error_message = "System prompt should not be empty"
+  }
+
+  assert {
+    condition     = length(regexall("Custom addition", coder_env.claude_code_system_prompt.value)) > 0
+    error_message = "System prompt should have system_prompt variable value"
+  }
+
+  # Ensure Coder sections are not injected when include=false
+  assert {
+    condition     = length(regexall("-- Tool Selection --|-- Task Reporting --", coder_env.claude_code_system_prompt.value)) == 0
+    error_message = "Coder integration sections should not be present when include_coder_system_prompt is false"
+  }
+}
+
+run "test_claude_code_include_coder_system_prompt_and_default_system_prompt" {
+  command = plan
+
+  variables {
+    agent_id = "test-agent-system-prompt"
+    workdir  = "/home/coder/test"
+    # system_prompt: default string is used
+    include_coder_system_prompt = true
+  }
+
+  assert {
+    condition     = trimspace(coder_env.claude_code_system_prompt.value) != ""
+    error_message = "System prompt should not be empty"
   }
 
   assert {
     condition     = length(regexall("-- Tool Selection --", coder_env.claude_code_system_prompt.value)) > 0
-    error_message = "Mandatory Tool Selection section missing"
+    error_message = "System prompt should have Tool Selection section"
   }
 
   assert {
     condition     = length(regexall("-- Task Reporting --", coder_env.claude_code_system_prompt.value)) > 0
-    error_message = "Mandatory Task Reporting section missing"
+    error_message = "System prompt should have Task Reporting section"
+  }
+
+  assert {
+    condition     = length(regexall("Send a task status update to notify the user that you are ready for input, and then wait for user input.", coder_env.claude_code_system_prompt.value)) > 0
+    error_message = "System prompt should have system_prompt variable default value"
   }
 }
 
-run "test_claude_code_system_prompt" {
+run "test_claude_code_include_coder_system_prompt_and_custom_system_prompt" {
   command = plan
 
   variables {
-    agent_id      = "test-agent-system-prompt"
-    workdir       = "/home/coder/test"
-    system_prompt = "Custom addition"
+    agent_id                    = "test-agent-system-prompt"
+    workdir                     = "/home/coder/test"
+    system_prompt               = "Custom addition"
+    include_coder_system_prompt = true
   }
 
   assert {
     condition     = trimspace(coder_env.claude_code_system_prompt.value) != ""
-    error_message = "System prompt must not be empty when omitted"
+    error_message = "System prompt should not be empty"
   }
 
   assert {
     condition     = length(regexall("-- Tool Selection --", coder_env.claude_code_system_prompt.value)) > 0
-    error_message = "Mandatory Tool Selection section missing"
+    error_message = "System prompt should have Tool Selection section"
   }
 
   assert {
     condition     = length(regexall("-- Task Reporting --", coder_env.claude_code_system_prompt.value)) > 0
-    error_message = "Mandatory Task Reporting section missing"
+    error_message = "System prompt should have Task Reporting section"
+  }
+
+  assert {
+    condition     = length(regexall("Custom addition", coder_env.claude_code_system_prompt.value)) > 0
+    error_message = "System prompt should have system_prompt variable value"
   }
 }