refactor(gitcommit): flatten tool response structures

- Remove nested output/user_msg/llm_msg wrapper objects
- Remove setup handlers from tool definitions
- Rename agent to tools in all handler signatures
- Remove v17 compatibility code and comments

Author: jinzhongjia

lua/codecompanion/_extensions/gitcommit/tools/ai_release_notes.lua

@@ -1,10 +1,9 @@
 local prompts = require("codecompanion._extensions.gitcommit.prompts.release_notes")
 
----@class CodeCompanion.GitCommit.Tools.AIReleaseNotes
+---@class CodeCompanion.GitCommit.Tools.AIReleaseNotes: CodeCompanion.Tools.Tool
 local AIReleaseNotes = {}
 
 AIReleaseNotes.name = "ai_release_notes"
-AIReleaseNotes.description = "Generate comprehensive release notes using AI analysis of commit history"
 
 AIReleaseNotes.schema = {
   type = "function",
@@ -194,77 +193,44 @@ AIReleaseNotes.cmds = {
     -- Get detailed commit history
     local commits, error_msg = get_detailed_commits(from_tag, to_tag)
     if not commits then
-      return {
-        status = "error",
-        data = {
-          output = error_msg,
-          user_msg = "✗ " .. error_msg,
-          llm_msg = "<aiReleaseNotes>fail: " .. error_msg .. "</aiReleaseNotes>",
-        },
-      }
+      return { status = "error", data = error_msg }
     end
 
     if #commits == 0 then
       local msg = string.format("No commits found between %s and %s", from_tag, to_tag)
-      return {
-        status = "success",
-        data = {
-          output = msg,
-          user_msg = "ℹ " .. msg,
-          llm_msg = "<aiReleaseNotes>success: " .. msg .. "</aiReleaseNotes>",
-        },
-      }
+      return { status = "success", data = msg }
     end
 
     local prompt = prompts.create_smart_prompt(commits, style, { from = from_tag, to = to_tag })
 
-    local user_msg =
-      string.format("📝 Generating %s release notes: %s → %s (%d commits)", style, from_tag, to_tag, #commits)
-
-    local llm_msg = string.format("<aiReleaseNotes>\n%s\n</aiReleaseNotes>", prompt)
-
-    return {
-      status = "success",
-      data = {
-        output = prompt,
-        user_msg = user_msg,
-        llm_msg = llm_msg,
-      },
-    }
+    return { status = "success", data = prompt }
   end,
 }
 
 AIReleaseNotes.handlers = {
-  setup = function(_self, _agent)
-    return true
-  end,
-  on_exit = function(_self, _agent) end,
+  on_exit = function(self, tools) end,
 }
 
 AIReleaseNotes.output = {
-  success = function(self, agent, _cmd, stdout)
-    local chat = agent.chat
-    local data = stdout[1]
-    local llm_msg = data and data.llm_msg or data.output
-    local user_msg = data and data.user_msg or data.output
-    return chat:add_tool_output(self, llm_msg, user_msg)
+  success = function(self, tools, cmd, stdout)
+    local chat = tools.chat
+    local output = stdout and #stdout > 0 and vim.iter(stdout):flatten():join("\n") or ""
+    local user_msg = "Release notes generated"
+    chat:add_tool_output(self, output, user_msg)
   end,
-  error = function(self, agent, _cmd, stderr, stdout)
-    local chat = agent.chat
-    local data = stderr[1] or stdout[1]
-    local llm_msg = data and data.llm_msg or (type(data) == "string" and data or "AI release notes generation failed")
-    local user_msg = data and data.user_msg or "AI release notes generation failed"
-    return chat:add_tool_output(self, llm_msg, user_msg)
+  error = function(self, tools, cmd, stderr, stdout)
+    local chat = tools.chat
+    local errors = stderr and #stderr > 0 and vim.iter(stderr):flatten():join("\n") or "Unknown error"
+    local user_msg = "Release notes generation failed"
+    chat:add_tool_output(self, errors, user_msg)
   end,
 }
 
 AIReleaseNotes.opts = {
-  -- v18+ uses require_approval_before
-  require_approval_before = function(_self, _agent)
+  require_approval_before = function(self, tools)
     return false
   end,
-  -- COMPAT(v17): Remove when dropping v17 support
-  requires_approval = function(_self, _agent)
+  requires_approval = function(self, tools)
     return false
   end,
 }

lua/codecompanion/_extensions/gitcommit/tools/git_edit.lua

@@ -1,11 +1,10 @@
 local GitTool = require("codecompanion._extensions.gitcommit.tools.git").GitTool
 local validation = require("codecompanion._extensions.gitcommit.tools.validation")
 
----@class CodeCompanion.GitCommit.Tools.GitEdit
+---@class CodeCompanion.GitCommit.Tools.GitEdit: CodeCompanion.Tools.Tool
 local GitEdit = {}
 
 GitEdit.name = "git_edit"
-GitEdit.description = "Tool for write-access Git operations like stage, unstage, branch creation, etc."
 
 GitEdit.schema = {
   type = "function",
@@ -587,14 +586,11 @@ Available write-access Git operations:
 }
 
 GitEdit.handlers = {
-  setup = function(self, agent)
-    return true
-  end,
-  on_exit = function(self, agent) end,
+  on_exit = function(self, tools) end,
 }
 
 GitEdit.output = {
-  prompt = function(self, _tools)
+  prompt = function(self, tools)
     local operation = self.args and self.args.operation or "unknown"
     local details = ""
     if operation == "stage" or operation == "unstage" then
@@ -612,36 +608,40 @@ GitEdit.output = {
     return string.format("Execute git %s%s?", operation, details)
   end,
 
-  success = function(self, agent, _cmd, stdout)
-    local chat = agent.chat
-    local operation = self.args.operation
-    local user_msg = string.format("Git edit operation [%s] executed successfully", operation)
-    return chat:add_tool_output(self, stdout[1], user_msg)
+  success = function(self, tools, cmd, stdout)
+    local chat = tools.chat
+    local operation = self.args and self.args.operation or "unknown"
+    local output = stdout and #stdout > 0 and vim.iter(stdout):flatten():join("\n") or ""
+    local user_msg = string.format("Git %s completed", operation)
+    chat:add_tool_output(self, output, user_msg)
   end,
 
-  error = function(self, agent, _cmd, stderr, stdout)
-    local chat = agent.chat
-    local operation = self.args.operation
-    local error_msg = stderr and stderr[1] or ("Git edit operation [%s] failed"):format(operation)
-    local user_msg = string.format("Git edit operation [%s] failed", operation)
-    return chat:add_tool_output(self, error_msg, user_msg)
+  error = function(self, tools, cmd, stderr, stdout)
+    local chat = tools.chat
+    local operation = self.args and self.args.operation or "unknown"
+    local errors = stderr and #stderr > 0 and vim.iter(stderr):flatten():join("\n") or "Unknown error"
+    local user_msg = string.format("Git %s failed", operation)
+    chat:add_tool_output(self, errors, user_msg)
   end,
 
-  rejected = function(self, tools, _cmd, _opts)
-    local chat = tools.chat
+  rejected = function(self, tools, cmd, opts)
     local operation = self.args and self.args.operation or "unknown"
     local message = string.format("User rejected the git %s operation", operation)
-    return chat:add_tool_output(self, message, message)
+    opts = vim.tbl_extend("force", { message = message }, opts or {})
+    local ok, helpers = pcall(require, "codecompanion.interactions.chat.tools.builtin.helpers")
+    if ok and helpers and helpers.rejected then
+      helpers.rejected(self, tools, cmd, opts)
+    else
+      tools.chat:add_tool_output(self, message)
+    end
   end,
 }
 
 GitEdit.opts = {
-  -- v18+ uses require_approval_before
-  require_approval_before = function(self, agent)
+  require_approval_before = function(self, tools)
     return true
   end,
-  -- COMPAT(v17): Remove when dropping v17 support
-  requires_approval = function(self, agent)
+  requires_approval = function(self, tools)
     return true
   end,
 }

lua/codecompanion/_extensions/gitcommit/tools/git_read.lua

@@ -1,11 +1,10 @@
 local GitTool = require("codecompanion._extensions.gitcommit.tools.git").GitTool
 local validation = require("codecompanion._extensions.gitcommit.tools.validation")
 
----@class CodeCompanion.GitCommit.Tools.GitRead
+---@class CodeCompanion.GitCommit.Tools.GitRead: CodeCompanion.Tools.Tool
 local GitRead = {}
 
 GitRead.name = "git_read"
-GitRead.description = "Tool for read-only Git operations like status, log, diff, etc."
 
 GitRead.schema = {
   type = "function",
@@ -315,77 +314,63 @@ GitRead.cmds = {
     -- Handle unexpected execution errors
     if not ok then
       local error_msg = "Git read operation failed unexpectedly: " .. tostring(result)
-      return {
-        status = "error",
-        data = {
-          output = error_msg,
-          user_msg = error_msg,
-          llm_msg = "<gitReadTool>fail: " .. error_msg .. "</gitReadTool>",
-        },
-      }
+      return { status = "error", data = error_msg }
     end
 
-    local success, output, user_msg, llm_msg = result.success, result.output, result.user_msg, result.llm_msg
+    local op_success, output = result.success, result.output
 
-    -- Ensure proper response format even if operation fails
-    if success then
-      return { status = "success", data = { output = output, user_msg = user_msg, llm_msg = llm_msg } }
+    if op_success then
+      return { status = "success", data = output or "Operation completed" }
     else
-      -- Ensure consistent error message format
-      local formatted_output = {
-        output = output or "Git read operation failed",
-        user_msg = user_msg or "Git read operation failed",
-        llm_msg = llm_msg or "<gitReadTool>fail: Git read operation failed</gitReadTool>",
-      }
-      return { status = "error", data = formatted_output }
+      return { status = "error", data = output or "Git read operation failed" }
     end
   end,
 }
 
 GitRead.handlers = {
-  setup = function(_self, _agent)
-    return true
-  end,
-  on_exit = function(_self, _agent) end,
+  on_exit = function(self, tools) end,
 }
 
 GitRead.output = {
-  prompt = function(self, _tools)
+  prompt = function(self, tools)
     local operation = self.args and self.args.operation or "unknown"
     return string.format("Execute git %s?", operation)
   end,
 
-  success = function(self, agent, _cmd, stdout)
-    local chat = agent.chat
-    local data = stdout[1]
-    local llm_msg = data and data.llm_msg or data.output
-    local user_msg = data and data.user_msg or data.output
-    return chat:add_tool_output(self, llm_msg, user_msg)
+  success = function(self, tools, cmd, stdout)
+    local chat = tools.chat
+    local operation = self.args and self.args.operation or "unknown"
+    local output = stdout and #stdout > 0 and vim.iter(stdout):flatten():join("\n") or ""
+    local user_msg = string.format("Git %s completed", operation)
+    chat:add_tool_output(self, output, user_msg)
   end,
 
-  error = function(self, agent, _cmd, stderr, stdout)
-    local chat = agent.chat
-    local data = stderr[1] or stdout[1]
-    local llm_msg = data and data.llm_msg or (type(data) == "string" and data or "Git read operation failed")
-    local user_msg = data and data.user_msg or "Git read operation failed"
-    return chat:add_tool_output(self, llm_msg, user_msg)
+  error = function(self, tools, cmd, stderr, stdout)
+    local chat = tools.chat
+    local operation = self.args and self.args.operation or "unknown"
+    local errors = stderr and #stderr > 0 and vim.iter(stderr):flatten():join("\n") or "Unknown error"
+    local user_msg = string.format("Git %s failed", operation)
+    chat:add_tool_output(self, errors, user_msg)
   end,
 
-  rejected = function(self, tools, _cmd, _opts)
-    local chat = tools.chat
+  rejected = function(self, tools, cmd, opts)
     local operation = self.args and self.args.operation or "unknown"
     local message = string.format("User rejected the git %s operation", operation)
-    return chat:add_tool_output(self, message, message)
+    opts = vim.tbl_extend("force", { message = message }, opts or {})
+    local ok, helpers = pcall(require, "codecompanion.interactions.chat.tools.builtin.helpers")
+    if ok and helpers and helpers.rejected then
+      helpers.rejected(self, tools, cmd, opts)
+    else
+      tools.chat:add_tool_output(self, message)
+    end
   end,
 }
 
 GitRead.opts = {
-  -- v18+ uses require_approval_before
-  require_approval_before = function(_self, _agent)
+  require_approval_before = function(self, tools)
     return false
   end,
-  -- COMPAT(v17): Remove when dropping v17 support
-  requires_approval = function(_self, _agent)
+  requires_approval = function(self, tools)
     return false
   end,
 }