feat: amazon-q module v2.0.0 with comprehensive AgentAPI integration

- Complete rewrite and enhancement of amazon-q module to v2.0.0
- AgentAPI Support: Web and CLI app integration with health checks
- Amazon Q CLI Integration: Automatic installation and configuration
- MCP Integration: Model Context Protocol support for task reporting to Coder
- Authentication System: Tarball-based authentication with environment variable management
- Pre/Post Install Scripts: Support for custom setup and finalization scripts
- Agent Configuration: Templated agent config with tool and resource management
- Custom System Prompts: Configurable AI behavior and task reporting instructions
- Version Pinning: Support for specific Amazon Q CLI and AgentAPI versions
- Comprehensive README: Complete user guide with examples and troubleshooting
- Terraform Testing: Complete .tftest.hcl with 8 test cases (all passing)
- Registry Compliance: Full adherence to Coder Registry contributing guidelines
- Fixed prettier formatting and standardized workdir to /home/coder
- Applied review feedback from 35C4n0r and team

Author: Michael Orlov

registry/coder/.images/amazon-q.png

@@ -3,6 +3,7 @@ run "required_variables" {
 
   variables {
     agent_id = "test-agent-id"
+    workdir  = "/tmp/test-workdir"
   }
 }
 
@@ -11,6 +12,7 @@ run "minimal_config" {
 
   variables {
     agent_id     = "test-agent-id"
+    workdir      = "/tmp/test-workdir"
     auth_tarball = "dGVzdA==" # base64 "test"
   }
 
@@ -32,6 +34,7 @@ run "test_case_1_basic_usage" {
 
   variables {
     agent_id     = "test-agent-id"
+    workdir      = "/tmp/test-workdir"
     auth_tarball = "dGVzdEF1dGhUYXJiYWxs" # base64 "testAuthTarball"
   }
 
@@ -72,6 +75,7 @@ run "test_case_2_autonomous_usage" {
 
   variables {
     agent_id     = "test-agent-id"
+    workdir      = "/tmp/test-workdir"
     auth_tarball = "dGVzdEF1dGhUYXJiYWxs" # base64 "testAuthTarball"
     ai_prompt    = "Help me set up a Python FastAPI project with proper testing structure"
   }
@@ -119,6 +123,7 @@ run "test_case_3_extended_configuration" {
 
   variables {
     agent_id            = "test-agent-id"
+    workdir             = "/tmp/test-workdir"
     auth_tarball        = "dGVzdEF1dGhUYXJiYWxs" # base64 "testAuthTarball"
     amazon_q_version    = "1.14.1"
     q_install_url       = "https://desktop-release.q.us-east-1.amazonaws.com"
@@ -185,6 +190,7 @@ run "full_config" {
 
   variables {
     agent_id            = "test-agent-id"
+    workdir             = "/tmp/test-workdir"
     install_amazon_q    = true
     install_agentapi    = true
     agentapi_version    = "v0.5.0"
@@ -233,6 +239,7 @@ run "auth_tarball_environment" {
 
   variables {
     agent_id     = "test-agent-id"
+    workdir      = "/tmp/test-workdir"
     auth_tarball = "dGVzdEF1dGhUYXJiYWxs" # base64 "testAuthTarball"
   }
 
@@ -252,6 +259,7 @@ run "empty_auth_tarball" {
 
   variables {
     agent_id     = "test-agent-id"
+    workdir      = "/tmp/test-workdir"
     auth_tarball = ""
   }
 
@@ -266,6 +274,7 @@ run "custom_system_prompt" {
 
   variables {
     agent_id      = "test-agent-id"
+    workdir       = "/tmp/test-workdir"
     system_prompt = "Custom system prompt for testing"
   }
 
@@ -281,6 +290,7 @@ run "install_options" {
 
   variables {
     agent_id         = "test-agent-id"
+    workdir          = "/tmp/test-workdir"
     install_amazon_q = false
     install_agentapi = false
   }
@@ -296,6 +306,7 @@ run "version_configuration" {
 
   variables {
     agent_id         = "test-agent-id"
+    workdir          = "/tmp/test-workdir"
     amazon_q_version = "2.15.0"
     agentapi_version = "v0.4.0"
   }
@@ -312,6 +323,7 @@ run "agent_name_extraction" {
 
   variables {
     agent_id = "test-agent-id"
+    workdir  = "/tmp/test-workdir"
     agent_config = jsonencode({
       name             = "custom-enterprise-agent"
       description      = "Custom enterprise agent configuration"
@@ -344,6 +356,7 @@ run "json_encoding_validation" {
 
   variables {
     agent_id      = "test-agent-id"
+    workdir       = "/tmp/test-workdir"
     system_prompt = "Multi-line\nsystem prompt\nwith newlines"
   }
 

registry/coder/modules/amazon-q/README.md

@@ -26,10 +26,12 @@ const baseAgentConfig = JSON.stringify({
 const requiredVars = {
   agent_id: "dummy-agent-id",
   agent_config: baseAgentConfig,
+  workdir: "/tmp/test-workdir",
 };
 
 const fullConfigVars = {
   agent_id: "dummy-agent-id",
+  workdir: "/tmp/test-workdir",
   install_amazon_q: true,
   install_agentapi: true,
   agentapi_version: "v0.6.0",
@@ -54,6 +56,7 @@ describe("amazon-q module v2.0.0", async () => {
   it("Test Case 1: Basic Usage - No Autonomous Use of Q", async () => {
     const basicUsageVars = {
       agent_id: "dummy-agent-id",
+      workdir: "/tmp/test-workdir",
       auth_tarball: "dGVzdEF1dGhUYXJiYWxs", // base64 "testAuthTarball"
     };
 
@@ -89,6 +92,7 @@ describe("amazon-q module v2.0.0", async () => {
   it("Test Case 2: Autonomous Usage - Autonomous Use of Q", async () => {
     const autonomousUsageVars = {
       agent_id: "dummy-agent-id",
+      workdir: "/tmp/test-workdir",
       auth_tarball: "dGVzdEF1dGhUYXJiYWxs", // base64 "testAuthTarball"
       ai_prompt:
         "Help me set up a Python FastAPI project with proper testing structure",
@@ -126,6 +130,7 @@ describe("amazon-q module v2.0.0", async () => {
   it("Test Case 3: Extended Configuration - Parameter Validation and File Rendering", async () => {
     const extendedConfigVars = {
       agent_id: "dummy-agent-id",
+      workdir: "/tmp/test-workdir",
       auth_tarball: "dGVzdEF1dGhUYXJiYWxs", // base64 "testAuthTarball"
       amazon_q_version: "1.14.1",
       q_install_url: "https://desktop-release.q.us-east-1.amazonaws.com",

registry/coder/modules/amazon-q/amazon-q.tftest.hcl

@@ -37,23 +37,71 @@ variable "icon" {
   default     = "/icon/amazon-q.svg"
 }
 
-
-variable "install_amazon_q" {
+variable "report_tasks" {
   type        = bool
-  description = "Whether to install Amazon Q."
+  description = "Whether to enable task reporting to Coder UI via AgentAPI"
   default     = true
 }
 
+variable "cli_app" {
+  type        = bool
+  description = "Whether to create a CLI app for Amazon Q"
+  default     = false
+}
+
+variable "web_app_display_name" {
+  type        = string
+  description = "Display name for the web app"
+  default     = "AmazonQ"
+}
+
+variable "cli_app_display_name" {
+  type        = string
+  description = "Display name for the CLI app"
+  default     = "AmazonQ CLI"
+}
+
 variable "install_agentapi" {
   type        = bool
   description = "Whether to install AgentAPI."
   default     = true
 }
 
+variable "ai_prompt" {
+  type        = string
+  description = "The initial task prompt to send to Amazon Q."
+  default     = ""
+}
+
+variable "pre_install_script" {
+  type        = string
+  description = "Optional script to run before installing Amazon Q."
+  default     = null
+}
+
+variable "post_install_script" {
+  type        = string
+  description = "Optional script to run after installing Amazon Q."
+  default     = null
+}
+
 variable "agentapi_version" {
   type        = string
   description = "The version of AgentAPI to install."
-  default     = "v0.6.0"
+  default     = "v0.6.1"
+}
+
+variable "workdir" {
+  type        = string
+  description = "The folder to run Amazon Q in."
+}
+
+# ---------------------------------------------
+
+variable "install_amazon_q" {
+  type        = bool
+  description = "Whether to install Amazon Q."
+  default     = true
 }
 
 variable "amazon_q_version" {
@@ -74,12 +122,6 @@ variable "trust_all_tools" {
   default     = false
 }
 
-variable "ai_prompt" {
-  type        = string
-  description = "The initial task prompt to send to Amazon Q."
-  default     = ""
-}
-
 variable "system_prompt" {
   type        = string
   description = "The system prompt to use for Amazon Q. This should instruct the agent how to do task reporting."
@@ -119,24 +161,18 @@ variable "auth_tarball" {
   sensitive   = true
 }
 
-variable "pre_install_script" {
-  type        = string
-  description = "Optional script to run before installing Amazon Q."
-  default     = null
-}
-
-variable "post_install_script" {
-  type        = string
-  description = "Optional script to run after installing Amazon Q."
-  default     = null
-}
-
 variable "agent_config" {
   type        = string
   description = "Optional Agent configuration JSON for Amazon Q."
   default     = null
 }
 
+variable "agentapi_chat_based_path" {
+  type        = bool
+  description = "Whether to use chat-based path for AgentAPI.Required if CODER_WILDCARD_ACCESS_URL is not defined in coder deployment"
+  default     = false
+}
+
 # Expose status slug to the agent environment
 resource "coder_env" "status_slug" {
   agent_id = var.agent_id
@@ -156,7 +192,7 @@ locals {
   app_slug               = "amazonq"
   install_script         = file("${path.module}/scripts/install.sh")
   start_script           = file("${path.module}/scripts/start.sh")
-  module_dir_name        = ".amazonq"
+  module_dir_name        = ".amazonq-module"
   system_prompt          = jsonencode(replace(var.system_prompt, "/[\r\n]/", ""))
   coder_mcp_instructions = jsonencode(replace(var.coder_mcp_instructions, "/[\r\n]/", ""))
 
@@ -165,17 +201,15 @@ locals {
     system_prompt = local.system_prompt
   })
 
-  # Use either custom agent config OR default, not merged
-  # Check if custom config is provided and valid
-  has_custom_config = var.agent_config != null && var.agent_config != ""
-
   # Choose the JSON string: use var.agent_config if provided, otherwise encode default
   agent_config = var.agent_config != null ? var.agent_config : local.default_agent_config
 
   # Extract agent name from the selected config
   agent_name = try(jsondecode(local.agent_config).name, "agent")
 
   full_prompt = var.ai_prompt != null ? "${var.ai_prompt}" : ""
+
+  server_chat_parameters = var.agentapi_chat_based_path ? "--chat-base-path /@${data.coder_workspace_owner.me.name}/${data.coder_workspace.me.name}.${var.agent_id}/apps/${local.app_slug}/chat" : ""
 }
 
 
@@ -188,9 +222,10 @@ module "agentapi" {
   web_app_order        = var.order
   web_app_group        = var.group
   web_app_icon         = var.icon
-  web_app_display_name = "Amazon Q"
-  cli_app_slug         = local.app_slug
-  cli_app_display_name = "Amazon Q"
+  web_app_display_name = var.web_app_display_name
+  cli_app              = var.cli_app
+  cli_app_slug         = var.cli_app ? "${local.app_slug}-cli" : null
+  cli_app_display_name = var.cli_app ? var.cli_app_display_name : null
   module_dir_name      = local.module_dir_name
   install_agentapi     = var.install_agentapi
   agentapi_version     = var.agentapi_version
@@ -207,7 +242,9 @@ module "agentapi" {
     ARG_TRUST_ALL_TOOLS='${var.trust_all_tools}' \
     ARG_AI_PROMPT='${base64encode(local.full_prompt)}' \
     ARG_MODULE_DIR_NAME='${local.module_dir_name}' \
-    ARG_SERVER_PARAMETERS="-c /@${data.coder_workspace_owner.me.name}/${data.coder_workspace.me.name}.${var.agent_id}/apps/${local.app_slug}/chat" \
+    ARG_WORKDIR='${var.workdir}' \
+    ARG_SERVER_PARAMETERS="${local.server_chat_parameters}" \
+    ARG_REPORT_TASKS='${var.report_tasks}' \
     /tmp/start.sh
   EOT
 
@@ -227,8 +264,7 @@ module "agentapi" {
     ARG_MODULE_DIR_NAME='${local.module_dir_name}' \
     ARG_CODER_MCP_APP_STATUS_SLUG='${local.app_slug}' \
     ARG_CODER_MCP_INSTRUCTIONS='${base64encode(local.coder_mcp_instructions)}' \
-    ARG_PRE_INSTALL_SCRIPT='${var.pre_install_script != null ? base64encode(var.pre_install_script) : ""}' \
-    ARG_POST_INSTALL_SCRIPT='${var.post_install_script != null ? base64encode(var.post_install_script) : ""}' \
+    ARG_REPORT_TASKS='${var.report_tasks}' \
     /tmp/install.sh
   EOT
 }