Debug mode (#121)

mateusz834 · web-flow · commit 88e048fe4202 · 2026-04-15T15:12:39.000+02:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -49,6 +49,7 @@ test = [
 release = ["build>=1.4.2", "jinja2>=3.1.6", "sphinx>=9.1.0", "twine>=6.2.0"]
 lint = ["basedpyright>=1.38.4", "ruff>=0.15.8"]
 dev = [
+  "rich>=14.3.3",
   "splunk-sdk[openai, anthropic]",
   { include-group = "test" },
   { include-group = "lint" },
diff --git a/splunklib/ai/engines/langchain.py b/splunklib/ai/engines/langchain.py
@@ -14,6 +14,7 @@
 
 import json
 import logging
+import os
 import uuid
 from collections.abc import Awaitable, Callable, Sequence
 from dataclasses import asdict, dataclass
@@ -119,6 +120,16 @@
 LC_AgentMiddleware = Langchain_AgentMiddleware[Any, "InvokeContext", Any]
 LC_ModelRequest = Langchain_ModelRequest["InvokeContext"]
 
+# Set to True to enable debugging mode.
+_DEBUG = False
+
+# Disallow _DEBUG == True in CI.
+# Github actions sets the CI env var.
+if _DEBUG and os.environ.get("CI") is not None:
+    raise Exception(
+        "_DEBUG can only be used in a local dev env and shouldn't ever be committed!"
+    )
+
 # Represents a prefix reserved only for internal use.
 # No user-visible tool or subagent name can be prefixed with it.
 RESERVED_LC_TOOL_PREFIX = "__"
@@ -475,6 +486,48 @@ def unpack_tool_call(self, call: LC_ToolCall) -> LC_ToolCall:
             lc_middleware.append(_ThreadIDMiddleware())
         lc_middleware.append(_SubagentArgumentPacker())
 
+        class _DEBUGMiddleware(LC_AgentMiddleware):
+            @override
+            async def awrap_model_call(
+                self,
+                request: LC_ModelRequest,
+                handler: Callable[[LC_ModelRequest], Awaitable[LC_ModelCallResult]],
+            ) -> LC_ModelCallResult:
+                from rich import print
+
+                print("LLM CALL", request)
+                try:
+                    resp = await handler(request)
+                except Exception as e:
+                    print("LLM FAILURE", e)
+                    raise
+
+                print("LLM RESPONSE", resp)
+                return resp
+
+            @override
+            async def awrap_tool_call(
+                self,
+                request: LC_ToolCallRequest,
+                handler: Callable[
+                    [LC_ToolCallRequest], Awaitable[LC_ToolMessage | LC_Command[None]]
+                ],
+            ) -> LC_ToolMessage | LC_Command[None]:
+                from rich import print
+
+                print("TOOL CALL", request)
+                try:
+                    resp = await handler(request)
+                except Exception as e:
+                    print("TOOL FAILURE", e)
+                    raise
+
+                print("TOOL RESPONSE", resp)
+                return resp
+
+        if _DEBUG:
+            lc_middleware.append(_DEBUGMiddleware())
+
         response_format = None
         if agent.output_schema is not None:
             if _supports_provider_strategy(model_impl):
diff --git a/uv.lock b/uv.lock
