Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Split agent api out as a separate friend module to metabot-v3 (#68814)

Noah Moss05c2aff0202c
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index 3af59f235dc..e8360e5f6ab 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -1790,6 +1790,17 @@
warehouses
enterprise/impersonation}}
+ enterprise/agent-api
+ {:team "Metabot"
+ :api #{metabase-enterprise.agent-api.api}
+ :uses #{api
+ auth-identity
+ query-processor
+ request
+ server
+ util
+ enterprise/metabot-v3}}
+
enterprise/ai-entity-analysis
{:team "Metabot"
:api #{metabase-enterprise.ai-entity-analysis.api}
@@ -2082,46 +2093,45 @@
util}}
enterprise/metabot-v3
- {:team "Metabot"
- :api #{metabase-enterprise.metabot-v3.agent-api.api
- metabase-enterprise.metabot-v3.api
- metabase-enterprise.metabot-v3.client
- metabase-enterprise.metabot-v3.core
- metabase-enterprise.metabot-v3.init
- metabase-enterprise.metabot-v3.tools.api}
- :uses #{activity-feed
- api
- app-db
- audit-app
- auth-identity
- collections
- config
- documents
- driver
- legacy-mbql
- lib
- lib-be
- models
- native-query-snippets
- permissions
- premium-features
- pulse
- query-processor
- request
- search
- server
- settings
- store-api
- sync
- system
- task
- users-rest
- util
- warehouse-schema
- warehouses-rest
- enterprise/dependencies
- enterprise/transforms
- enterprise/transforms-python}}
+ {:team "Metabot"
+ :api #{metabase-enterprise.metabot-v3.api
+ metabase-enterprise.metabot-v3.client
+ metabase-enterprise.metabot-v3.core
+ metabase-enterprise.metabot-v3.init
+ metabase-enterprise.metabot-v3.tools.api}
+ :friends #{enterprise/agent-api}
+ :uses #{activity-feed
+ api
+ app-db
+ audit-app
+ collections
+ config
+ documents
+ driver
+ legacy-mbql
+ lib
+ lib-be
+ models
+ native-query-snippets
+ permissions
+ premium-features
+ pulse
+ query-processor
+ request
+ search
+ server
+ settings
+ store-api
+ sync
+ system
+ task
+ users-rest
+ util
+ warehouse-schema
+ warehouses-rest
+ enterprise/dependencies
+ enterprise/transforms
+ enterprise/transforms-python}}
enterprise/permission-debug
{:team "UX West"
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/agent_api/api.clj b/enterprise/backend/src/metabase_enterprise/agent_api/api.clj
similarity index 97%
rename from enterprise/backend/src/metabase_enterprise/metabot_v3/agent_api/api.clj
rename to enterprise/backend/src/metabase_enterprise/agent_api/api.clj
index 4bace99f2dd..97c5014e867 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/agent_api/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/agent_api/api.clj
@@ -1,4 +1,4 @@
-(ns metabase-enterprise.metabot-v3.agent-api.api
+(ns metabase-enterprise.agent-api.api
"Customer-facing Agent API for headless BI applications.
Endpoints are versioned (e.g., /v1/search) and use standard HTTP semantics."
(:require
@@ -29,11 +29,13 @@
;;; ---------------------------------------------------- Helpers ------------------------------------------------------
(defn- check-tool-result
- "Extract :structured-output from a tool result, or throw 404 with the error message.
- Tool functions return {:structured-output ...} on success, {:output \"error\"} on failure."
- [{:keys [structured-output output]}]
+ "Extract :structured-output from a tool result, or throw with the appropriate HTTP status code.
+ Tool functions return {:structured-output ...} on success,
+ {:output \"error\" :status-code 4xx/5xx} on failure.
+ Defaults to 404 if no status-code is provided for backwards compatibility."
+ [{:keys [structured-output output status-code]}]
(or structured-output
- (api/check false [404 (or output "Not found.")])))
+ (api/check false [(or status-code 404) (or output "Not found.")])))
;;; --------------------------------------------------- Schemas ------------------------------------------------------
diff --git a/enterprise/backend/src/metabase_enterprise/api_routes/routes.clj b/enterprise/backend/src/metabase_enterprise/api_routes/routes.clj
index 6ff938fac84..a27b22c6ea7 100644
--- a/enterprise/backend/src/metabase_enterprise/api_routes/routes.clj
+++ b/enterprise/backend/src/metabase_enterprise/api_routes/routes.clj
@@ -8,6 +8,7 @@
[metabase-enterprise.action-v2.api]
[metabase-enterprise.advanced-config.api.logs]
[metabase-enterprise.advanced-permissions.api.routes]
+ [metabase-enterprise.agent-api.api]
[metabase-enterprise.ai-entity-analysis.api]
[metabase-enterprise.ai-sql-fixer.api]
[metabase-enterprise.ai-sql-generation.api]
@@ -26,7 +27,6 @@
[metabase-enterprise.gsheets.api :as gsheets.api]
[metabase-enterprise.library.api]
[metabase-enterprise.llm.api]
- [metabase-enterprise.metabot-v3.agent-api.api]
[metabase-enterprise.metabot-v3.api]
[metabase-enterprise.metabot-v3.tools.api]
[metabase-enterprise.permission-debug.api]
@@ -47,7 +47,7 @@
(comment metabase-enterprise.advanced-config.api.logs/keep-me
metabase-enterprise.llm.api/keep-me
- metabase-enterprise.metabot-v3.agent-api.api/keep-me)
+ metabase-enterprise.agent-api.api/keep-me)
(def ^:private required-feature->message
{:advanced-permissions (deferred-tru "Advanced Permissions")
@@ -90,7 +90,7 @@
`/ee/<feature>/`).
TODO -- Please fix them! See #22687"
- {"/agent" (premium-handler metabase-enterprise.metabot-v3.agent-api.api/routes :agent-api)
+ {"/agent" (premium-handler metabase-enterprise.agent-api.api/routes :agent-api)
"/moderation-review" metabase-enterprise.content-verification.api.routes/routes
"/mt" metabase-enterprise.sandbox.api.routes/sandbox-routes
"/table" metabase-enterprise.sandbox.api.routes/sandbox-table-routes})
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj
index ee0c19db8d5..4a596904b70 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj
@@ -43,7 +43,7 @@
;;; ------------------------------------------------ Shared Schemas -------------------------------------------------
;; NOTE: Some of these schemas are duplicated with small differences in the Agent API
-;; (metabase-enterprise.metabot-v3.agent-api.api). If you update schemas here, check if the
+;; (metabase-enterprise.agent-api.api). If you update schemas here, check if the
;; corresponding Agent API schemas need updating too.
(mr/def ::bucket
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/agent_api/api_test.clj b/enterprise/backend/test/metabase_enterprise/agent_api/api_test.clj
similarity index 99%
rename from enterprise/backend/test/metabase_enterprise/metabot_v3/agent_api/api_test.clj
rename to enterprise/backend/test/metabase_enterprise/agent_api/api_test.clj
index e5c25e75b43..8178d51b656 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/agent_api/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/agent_api/api_test.clj
@@ -1,4 +1,4 @@
-(ns metabase-enterprise.metabot-v3.agent-api.api-test
+(ns metabase-enterprise.agent-api.api-test
(:require
[buddy.sign.jwt :as jwt]
[clojure.test :refer :all]