Support visible field in hooks configuration to show or not in client.

Author: ericdallo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Support `visible` field in hooks configuration to show or not in client.
+
 ## 0.70.3
 
 - Deprecate prePrompt and postPrompt in favor of preRequest and prePrompt.

docs/configuration.md

@@ -370,6 +370,8 @@ __Output__: All hook actions allow printing output (stdout) and errors (stderr)
 
 __Matcher__: Specify whether to apply this hook checking a regex applying to `mcp__tool-name`, applicable only for `*ToolCall` hooks.
 
+__Visible__: whether to show or not this hook in chat when executing, defaults to true.
+
 Examples:
 
 === "Notify after prompt finish"
@@ -398,6 +400,7 @@ Examples:
         "check-my-tool": {
           "type": "preToolCall", 
           "matcher": "my-mcp__some-tool",
+          "visible": false,
           "actions": [
             {
               "type": "shell",
@@ -446,6 +449,7 @@ To configure, add your OTLP collector config via `:otlp` map following [otlp aut
         hooks?: {[key: string]: {
                 type: 'preToolCall' | 'postToolCall' | 'preRequest' | 'postRequest';
                 matcher: string;
+                visible?: boolean;
                 actions: {
                     type: 'shell';
                     shell: string;

src/eca/features/chat.clj

@@ -34,22 +34,24 @@
     :role role
     :content content}))
 
-(defn ^:private notify-before-hook-action! [chat-ctx {:keys [id name type]}]
-  (send-content! chat-ctx :system
-                 {:type :hookActionStarted
-                  :action-type type
-                  :name name
-                  :id id}))
+(defn ^:private notify-before-hook-action! [chat-ctx {:keys [id name type visible?]}]
+  (when visible?
+    (send-content! chat-ctx :system
+                   {:type :hookActionStarted
+                    :action-type type
+                    :name name
+                    :id id})))
 
-(defn ^:private notify-after-hook-action! [chat-ctx {:keys [id name output error status type]}]
-  (send-content! chat-ctx :system
-                 {:type :hookActionFinished
-                  :action-type type
-                  :id id
-                  :name name
-                  :status status
-                  :output output
-                  :error error}))
+(defn ^:private notify-after-hook-action! [chat-ctx {:keys [id name output error status type visible?]}]
+  (when visible?
+    (send-content! chat-ctx :system
+                   {:type :hookActionFinished
+                    :action-type type
+                    :id id
+                    :name name
+                    :status status
+                    :output output
+                    :error error})))
 
 (defn finish-chat-prompt! [status {:keys [message chat-id db* metrics config on-finished-side-effect] :as chat-ctx}]
   (swap! db* assoc-in [:chats chat-id :status] status)

src/eca/features/hooks.clj

@@ -55,18 +55,22 @@
                             type (:type action)
                             name (if (> 1 (count (:actions hook)))
                                    (str name "-" (inc i))
-                                   name)]
+                                   name)
+                            visible? (get hook :visible true)]
                         (on-before-action {:id id
+                                           :visible? visible?
                                            :name name})
                         (if-let [[status output error] (run-hook-action! action name data db)]
                           (on-after-action {:id id
                                             :name name
                                             :type type
+                                            :visible? visible?
                                             :status status
                                             :output output
                                             :error error})
                           (on-after-action {:id id
                                             :name name
+                                            :visible? visible?
                                             :type type
                                             :status -1}))))
                     (:actions hook))))))

test/eca/features/hooks_test.clj

@@ -30,11 +30,13 @@
          (h/config)))
       (is (match?
            {:id string?
+            :visible? true
             :name "my-hook"}
            @on-before-action*))
       (is (match?
            {:id string?
             :name "my-hook"
+            :visible? true
             :status 0
             :output "hey"
             :error nil}
@@ -56,11 +58,42 @@
          (h/config)))
       (is (match?
            {:id string?
+            :visible? true
             :name "my-hook"}
            @on-before-action*))
       (is (match?
            {:id string?
             :name "my-hook"
+            :visible? true
+            :status 0
+            :output "hey"
+            :error nil}
+           @on-after-action*))))
+  (testing "when visible is false"
+    (h/reset-components!)
+    (h/config! {:hooks {"my-hook" {:type "preRequest"
+                                   :visible false
+                                   :actions [{:type "shell"
+                                              :shell "echo hey"}]}}})
+    (let [on-before-action* (atom nil)
+          on-after-action* (atom nil)]
+      (with-redefs [p/sh (constantly {:exit 0 :out "hey" :err nil})]
+        (f.hooks/trigger-if-matches!
+         :preRequest
+         {:foo "1"}
+         {:on-before-action (set-action-payload on-before-action*)
+          :on-after-action (set-action-payload on-after-action*)}
+         (h/db)
+         (h/config)))
+      (is (match?
+           {:id string?
+            :visible? false
+            :name "my-hook"}
+           @on-before-action*))
+      (is (match?
+           {:id string?
+            :name "my-hook"
+            :visible? false
             :status 0
             :output "hey"
             :error nil}
@@ -107,11 +140,13 @@
          (h/config)))
       (is (match?
            {:id string?
+            :visible? true
             :name "my-hook"}
            @on-before-action*))
       (is (match?
            {:id string?
             :name "my-hook"
+            :visible? true
             :status 2
             :output nil
             :error "stop!"}