merge main

Author: ravitemer

CHANGELOG.md

@@ -141,11 +141,79 @@ By default when the LLM calls a tool or resource on a MCP server, we show a conf
 
 ![Image](https://github.com/user-attachments/assets/201a5804-99b6-4284-9351-348899e62467)
 
-Set it to `true` to automatically approve all MCP tool calls without user confirmation. This also sets `vim.g.mcphub_auto_approve` variable to `true`. You can toggle this option in the MCP Hub UI with `ga` keymap. You can see the current auto approval status in the Hub UI.
+#### Boolean Auto-Approval
+
+Set it to `true` to automatically approve all MCP tool calls without user confirmation:
+
+```lua
+require("mcphub").setup({
+    auto_approve = true, -- Auto approve all MCP tool calls
+})
+```
+
+This also sets `vim.g.mcphub_auto_approve` variable to `true`. You can toggle this option in the MCP Hub UI with `ga` keymap. You can see the current auto approval status in the Hub UI.
 
 ![Image](https://github.com/user-attachments/assets/64708065-3428-4eb3-82a5-e32d2d1f98c6)
 
-**Fine-Grained Auto-Approval**: For more granular control, configure auto-approval per server or per tool using the `autoApprove` field in your `servers.json`. You can also toggle auto-approval from the Hub UI using the `a` keymap on individual servers or tools. See [servers.json configuration](/mcp/servers_json#auto-approval-configuration) for detailed examples and configuration options.
+#### Function-Based Auto-Approval
+
+For maximum control, provide a function that decides approval based on the specific tool call:
+
+```lua
+require("mcphub").setup({
+    auto_approve = function(params)
+        -- Auto-approve GitHub issue reading
+        if params.server_name == "github" and params.tool_name == "get_issue" then
+            return true -- Auto approve
+        end
+        
+        -- Block access to private repos
+        if params.arguments.repo == "private" then
+            return "You can't access my private repo" -- Error message
+        end
+        
+        -- Auto-approve safe file operations in current project
+        if params.tool_name == "read_file" then
+            local path = params.arguments.path or ""
+            if path:match("^" .. vim.fn.getcwd()) then
+                return true -- Auto approve
+            end
+        end
+        
+        -- Check if tool is configured for auto-approval in servers.json
+        if params.is_auto_approved_in_server then
+            return true -- Respect servers.json configuration
+        end
+        
+        return false -- Show confirmation prompt
+    end,
+})
+```
+
+**Parameters available in the function:**
+- `params.server_name` - Name of the MCP server
+- `params.tool_name` - Name of the tool being called (nil for resources)
+- `params.arguments` - Table of arguments passed to the tool
+- `params.action` - Either "use_mcp_tool" or "access_mcp_resource"
+- `params.uri` - Resource URI (for resource access)
+- `params.is_auto_approved_in_server` - Boolean indicating if tool is configured for auto-approval in servers.json
+
+**Return values:**
+- `true` - Auto-approve the call
+- `false` - Show confirmation prompt
+- `string` - Deny with error message
+- `nil` - Show confirmation prompt (same as false)
+
+#### Server-Level Auto-Approval
+
+For fine-grained control per server or tool, configure auto-approval using the `autoApprove` field in your `servers.json`. You can also toggle auto-approval from the Hub UI using the `a` keymap on individual servers or tools. See [servers.json configuration](/mcp/servers_json#auto-approval-configuration) for detailed examples and configuration options.
+
+#### Auto-Approval Priority
+
+The system checks auto-approval in this order:
+1. **Function**: Custom `auto_approve` function (if provided)
+2. **Server-specific**: `autoApprove` field in server config
+3. **Default**: Show confirmation dialog
 
 ### auto_toggle_mcp_servers
 
@@ -259,3 +327,4 @@ Logging configuration options:
 
 
 
+

doc/configuration.md

@@ -120,10 +120,59 @@ You can also toggle auto-approval from the Hub UI:
 - Press `a` on an individual tool to toggle auto-approval for just that tool
 - Resources are always auto-approved (no configuration needed)
 
+### Function-Based Auto-Approval
+
+For maximum control, provide a function that decides approval based on the specific tool call:
+
+```lua
+require("mcphub").setup({
+    auto_approve = function(params)
+        -- Auto-approve GitHub issue reading
+        if params.server_name == "github" and params.tool_name == "get_issue" then
+            return true -- Auto approve
+        end
+        
+        -- Block access to private repos
+        if params.arguments.repo == "private" then
+            return "You can't access my private repo" -- Error message
+        end
+        
+        -- Auto-approve safe file operations in current project
+        if params.tool_name == "read_file" then
+            local path = params.arguments.path or ""
+            if path:match("^" .. vim.fn.getcwd()) then
+                return true -- Auto approve
+            end
+        end
+        
+        -- Check if tool is configured for auto-approval in servers.json
+        if params.is_auto_approved_in_server then
+            return true -- Respect servers.json configuration
+        end
+        
+        return false -- Show confirmation prompt
+    end,
+})
+```
+
+**Parameters available in the function:**
+- `params.server_name` - Name of the MCP server
+- `params.tool_name` - Name of the tool being called (nil for resources)
+- `params.arguments` - Table of arguments passed to the tool
+- `params.action` - Either "use_mcp_tool" or "access_mcp_resource"
+- `params.uri` - Resource URI (for resource access)
+- `params.is_auto_approved_in_server` - Boolean indicating if tool is configured for auto-approval in servers.json
+
+**Return values:**
+- `true` - Auto-approve the call
+- `false` - Show confirmation prompt
+- `string` - Deny with error message
+- `nil` - Show confirmation prompt (same as false)
+
 ### Auto-Approval Priority
 
 The system checks auto-approval in this order:
-1. **Global**: `vim.g.mcphub_auto_approve = true` (approves everything)
+1. **Function**: Custom `auto_approve` function (if provided)
 2. **Server-specific**: `autoApprove` field in server config
 3. **Default**: Show confirmation dialog
 
@@ -136,3 +185,4 @@ The system checks auto-approval in this order:
 
 
 
+

doc/extensions/avante.md

@@ -198,10 +198,67 @@ You can also toggle auto-approval from the Hub UI:
 - Press `a` on an individual tool to toggle auto-approval for just that tool
 - Resources are always auto-approved (no configuration needed)
 
-#### Auto-Approval Priority
+### Function-Based Auto-Approval
+
+For maximum control, provide a function that decides approval based on the specific tool call:
+
+```lua
+require("mcphub").setup({
+    auto_approve = function(params)
+        -- Respect CodeCompanion's auto tool mode when enabled
+        if vim.g.codecompanion_auto_tool_mode == true then
+            return true -- Auto approve when CodeCompanion auto-tool mode is on
+        end
+        
+        -- Auto-approve GitHub issue reading
+        if params.server_name == "github" and params.tool_name == "get_issue" then
+            return true -- Auto approve
+        end
+        
+        -- Block access to private repos
+        if params.arguments.repo == "private" then
+            return "You can't access my private repo" -- Error message
+        end
+        
+        -- Auto-approve safe file operations in current project
+        if params.tool_name == "read_file" then
+            local path = params.arguments.path or ""
+            if path:match("^" .. vim.fn.getcwd()) then
+                return true -- Auto approve
+            end
+        end
+        
+        -- Check if tool is configured for auto-approval in servers.json
+        if params.is_auto_approved_in_server then
+            return true -- Respect servers.json configuration
+        end
+        
+        return false -- Show confirmation prompt
+    end,
+})
+```
+
+**Parameters available in the function:**
+- `params.server_name` - Name of the MCP server
+- `params.tool_name` - Name of the tool being called (nil for resources)
+- `params.arguments` - Table of arguments passed to the tool
+- `params.action` - Either "use_mcp_tool" or "access_mcp_resource"
+- `params.uri` - Resource URI (for resource access)
+- `params.is_auto_approved_in_server` - Boolean indicating if tool is configured for auto-approval in servers.json
+
+**Return values:**
+- `true` - Auto-approve the call
+- `false` - Show confirmation prompt
+- `string` - Deny with error message
+- `nil` - Show confirmation prompt (same as false)
+
+### Auto-Approval Priority
 
 The system checks auto-approval in this order:
-1. **Global**: `vim.g.mcphub_auto_approve = true` (approves everything)
-2. **CodeCompanion**: `vim.g.codecompanion_auto_tool_mode = true` (toggled via `gta` in chat buffer)
-3. **Server-specific**: `autoApprove` field in server config
-4. **Default**: Show confirmation dialog
+1. **Function**: Custom `auto_approve` function (if provided)
+2. **Server-specific**: `autoApprove` field in server config
+3. **Default**: Show confirmation dialog
+
+
+
+

doc/extensions/codecompanion.md

@@ -19,6 +19,7 @@ local defaults = {
             },
         },
     },
+    ---@type boolean | fun(parsed_params: MCPHub.ParsedParams): boolean | nil | string  Function to determine if a call should be auto-approved
     auto_approve = false,
     auto_toggle_mcp_servers = true, -- Let LLMs start and stop MCP servers automatically
     use_bundled_binary = false, -- Whether to use bundled mcp-hub binary
@@ -38,8 +39,8 @@ local defaults = {
         window = {},
         wo = {},
     },
+    ---@type MCPHub.Extensions.Config
     extensions = {
-        ---@type MCPHubAvanteConfig
         avante = {
             enabled = true,
             make_slash_commands = true,

lua/mcphub/config.lua

@@ -1,3 +1,4 @@
+---@module "avante"
 --[[
 *MCP Servers Tool*
 This tool can be used to call tools and resources from the MCP Servers.
@@ -6,10 +7,17 @@ M.mcp_tool() will return a use_mcp_tool and access_mcp_resource function schemas
 M.use_mcp_tool() will return schema for calling tools on MCP servers.
 M.access_mcp_resource() will return schema for accessing resources on MCP servers.
 --]]
+
+---@class MCPHub.Extensions.Avante
+---@field setup function(config: MCPHub.Extensions.AvanteConfig) Setup slash commands and other configurations for Avante extension
+---@field mcp_tool fun(): AvanteLLMTool,AvanteLLMTool
+---@field use_mcp_tool AvanteLLMTool
+---@field access_mcp_resource AvanteLLMTool
+
+---@class MCPHub.Extensions.Avante
 local M = {}
-local async = require("plenary.async")
-local shared = require("mcphub.extensions.shared")
 
+---@type table<MCPHub.ActionType, AvanteLLMTool>
 local tool_schemas = {
     use_mcp_tool = {
         name = "use_mcp_tool",
@@ -34,6 +42,7 @@ local tool_schemas = {
                 },
             },
         },
+        returns = {}, -- Will be added dynamically in mcp_tool()
     },
 
     access_mcp_resource = {
@@ -54,11 +63,16 @@ local tool_schemas = {
                 },
             },
         },
+        returns = {}, -- Will be added dynamically in mcp_tool()
     },
 }
 
----@return table,table
+---@return AvanteLLMTool use_mcp_tool
+---@return AvanteLLMTool access_mcp_resource
 function M.mcp_tool()
+    ---@param str string
+    ---@param max_length number
+    ---@return string
     local function truncate_utf8(str, max_length)
         if type(str) ~= "string" or #str <= max_length then
             return str
@@ -80,7 +94,10 @@ function M.mcp_tool()
         return str:sub(1, i - 1) .. "... (truncated)"
     end
 
+    local async = require("plenary.async")
+    local shared = require("mcphub.extensions.shared")
     for action_name, schema in pairs(tool_schemas) do
+        ---@type AvanteLLMToolFunc<MCPHub.ToolCallArgs | MCPHub.ResourceAccessArgs>
         schema.func = function(args, on_log, on_complete)
             ---@diagnostic disable-next-line: missing-parameter
             async.run(function()
@@ -92,13 +109,10 @@ function M.mcp_tool()
                 if #params.errors > 0 then
                     return on_complete(nil, table.concat(params.errors, "\n"))
                 end
-                -- Check both global and server-specific auto-approval
-                local auto_approve = vim.g.mcphub_auto_approve == true or params.should_auto_approve
-                if not auto_approve then
-                    local confirmed = shared.show_mcp_tool_prompt(params)
-                    if not confirmed then
-                        return on_complete(nil, "User cancelled the operation")
-                    end
+
+                local result = shared.handle_auto_approval_decision(params)
+                if result.error then
+                    return on_complete(nil, result.error)
                 end
                 local sidebar = require("avante").get()
                 if params.action == "access_mcp_resource" then
@@ -154,6 +168,8 @@ function M.mcp_tool()
                 end
             end)
         end
+
+        ---@type AvanteLLMToolReturn[]
         schema.returns = {
             {
                 name = "result",
@@ -173,4 +189,11 @@ function M.mcp_tool()
     return unpack(vim.tbl_values(tool_schemas))
 end
 
+---@param config MCPHub.Extensions.AvanteConfig
+function M.setup(config)
+    if config.make_slash_commands then
+        require("mcphub.extensions.avante.slash_commands").setup()
+    end
+end
+
 return M