Add Metabase AI Tools

extensions/metabase/CHANGELOG.md

@@ -1,3 +1,5 @@
 # Metabase Changelog
 
+## [AI Tools] - 2025-07-07
+
 ## [Initial Version] - 2025-02-01

extensions/metabase/eslint.config.js

@@ -0,0 +1,4 @@
+const { defineConfig } = require("eslint/config");
+const raycastConfig = require("@raycast/eslint-config");
+
+module.exports = defineConfig([...raycastConfig]);

extensions/metabase/package.json

@@ -21,6 +21,195 @@
       "mode": "view"
     }
   ],
+  "tools": [
+    {
+      "name": "get-databases",
+      "title": "Get Databases",
+      "description": "Search the saved databases in Metabase"
+    },
+    {
+      "name": "get-questions",
+      "title": "Get Questions",
+      "description": "Get the saved Metabase questions"
+    },
+    {
+      "name": "run-query",
+      "title": "Run Query",
+      "description": "Run a native SQL query against a database"
+    },
+    {
+      "name": "run-question",
+      "title": "Run Question",
+      "description": "Get latest saved question results"
+    }
+  ],
+  "ai": {
+    "instructions": "When fetching data from Metabase, always retrieve the saved questions and execute them if they match the requested information. If they do not match, get the databases and run a native SQL query based on their metadata. You can retrieve both the saved questions and the databases in parallel so you can make the best decision.\n\nDon't use variables like 'YOUR_USER_ID' when running queries manually.",
+    "evals": [
+      {
+        "input": "@metabase How many registered users do I have?",
+        "mocks": {
+          "get-databases": {
+            "databases": [
+              {
+                "engine": "postgres",
+                "id": 2,
+                "name": "PostgreSQL",
+                "schema": {
+                  "enums": [],
+                  "tables": [
+                    {
+                      "columns": {
+                        "created_at": "timestamp with time zone",
+                        "id": "bigint",
+                        "referred_id": "bigint",
+                        "referrer_id": "bigint",
+                        "updated_at": "timestamp with time zone"
+                      },
+                      "name": "referrals"
+                    },
+                    {
+                      "columns": {
+                        "created_at": "timestamp with time zone",
+                        "id": "bigint",
+                        "internal": "boolean",
+                        "referral_code": "text",
+                        "updated_at": "timestamp with time zone",
+                        "username": "text"
+                      },
+                      "name": "users"
+                    }
+                  ]
+                }
+              }
+            ]
+          },
+          "get-questions": {
+            "questions": [
+              {
+                "id": 72,
+                "name": "Registered Users",
+                "description": null,
+                "databaseId": 2,
+                "databaseQuery": "SELECT count(*) FROM users WHERE username is not null"
+              }
+            ]
+          },
+          "run-question": {
+            "result": [
+              [
+                382194
+              ]
+            ]
+          }
+        },
+        "expected": [
+          {
+            "callsTool": {
+              "arguments": {},
+              "name": "get-questions"
+            }
+          },
+          {
+            "callsTool": {
+              "arguments": {},
+              "name": "get-databases"
+            }
+          },
+          {
+            "callsTool": {
+              "arguments": {
+                "questionId": 72,
+                "requiresConfirmation": true
+              },
+              "name": "run-question"
+            }
+          }
+        ]
+      },
+      {
+        "input": "@metabase When did the user named \"vimtor\" sign up?",
+        "mocks": {
+          "get-databases": {
+            "databases": [
+              {
+                "engine": "postgres",
+                "id": 2,
+                "name": "PostgreSQL",
+                "schema": {
+                  "enums": [],
+                  "tables": [
+                    {
+                      "columns": {
+                        "created_at": "timestamp with time zone",
+                        "id": "bigint",
+                        "referred_id": "bigint",
+                        "referrer_id": "bigint",
+                        "updated_at": "timestamp with time zone"
+                      },
+                      "name": "referrals"
+                    },
+                    {
+                      "columns": {
+                        "created_at": "timestamp with time zone",
+                        "id": "bigint",
+                        "internal": "boolean",
+                        "referral_code": "text",
+                        "updated_at": "timestamp with time zone",
+                        "username": "text"
+                      },
+                      "name": "users"
+                    }
+                  ]
+                }
+              }
+            ]
+          },
+          "get-questions": {
+            "questions": [
+              {
+                "id": 72,
+                "name": "Registered Users",
+                "description": null,
+                "databaseId": 2,
+                "databaseQuery": "SELECT count(*) FROM users WHERE username is not null"
+              }
+            ]
+          },
+          "run-query": {
+            "result": [
+              [
+                "2024-12-13T21:01:06.329864Z"
+              ]
+            ]
+          }
+        },
+        "expected": [
+          {
+            "callsTool": {
+              "arguments": {},
+              "name": "get-questions"
+            }
+          },
+          {
+            "callsTool": {
+              "arguments": {},
+              "name": "get-databases"
+            }
+          },
+          {
+            "callsTool": {
+              "arguments": {
+                "databaseId": 2,
+                "query": "SELECT created_at FROM users WHERE username = 'vimtor' LIMIT 1;"
+              },
+              "name": "run-query"
+            }
+          }
+        ]
+      }
+    ]
+  },
   "preferences": [
     {
       "name": "instanceUrl",
@@ -40,16 +229,16 @@
     }
   ],
   "dependencies": {
-    "@raycast/api": "^1.90.0",
+    "@raycast/api": "^1.100.3",
     "@raycast/utils": "^1.17.0"
   },
   "devDependencies": {
-    "@raycast/eslint-config": "^1.0.11",
-    "@types/node": "20.8.10",
-    "@types/react": "18.3.3",
-    "eslint": "^8.57.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.4.5"
+    "@raycast/eslint-config": "^2.0.4",
+    "@types/node": "22.13.10",
+    "@types/react": "19.0.10",
+    "eslint": "^9.22.0",
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.2"
   },
   "scripts": {
     "build": "ray build",

extensions/metabase/src/lib/api.ts

@@ -0,0 +1,136 @@
+import { getPreferenceValues } from "@raycast/api";
+
+const preferences = getPreferenceValues<Preferences.SearchQuestions>();
+
+export interface Database {
+  id: number;
+  name: string;
+  engine: string;
+  tables: {
+    name: string;
+    schema: string;
+    // and other fields
+  }[];
+}
+
+export interface Card {
+  id: number;
+  name: string;
+  description: string | null;
+  created_at: string;
+  updated_at: string;
+  archived: boolean;
+  view_count: number;
+  display: "bar" | "table" | "scalar" | "line" | "pie" | (string & Record<string, never>);
+  dataset_query: {
+    database: number;
+    native: {
+      query: string;
+      template_tags: Record<string, { display_name: string; id: string; name: string; type: string }>;
+    };
+    type: "native";
+  };
+  creator: {
+    email: string;
+    first_name: string;
+    last_login: string;
+    is_qbnewb: boolean;
+    is_superuser: boolean;
+    id: number;
+    last_name: string;
+    date_joined: string;
+    common_name: string;
+  };
+}
+
+export interface Query {
+  rows: string[][];
+}
+
+export async function runQuery(input: { query: string; databaseId: number }) {
+  const endpoint = new URL(`/api/dataset`, preferences.instanceUrl);
+
+  return fetch(endpoint.toString(), {
+    method: "POST",
+    headers: {
+      accept: "application/json",
+      "content-type": "application/json",
+      "x-api-key": preferences.apiToken,
+    },
+    body: JSON.stringify({
+      database: input.databaseId,
+      type: "native",
+      native: {
+        query: input.query,
+      },
+    }),
+  })
+    .then((res) => res.json() as Promise<{ data: Query }>)
+    .then((res) => res.data);
+}
+
+export async function getQuestion(input: { questionId: number }) {
+  const endpoint = new URL(`/api/card/${input.questionId}`, preferences.instanceUrl);
+
+  return fetch(endpoint.toString(), {
+    method: "GET",
+    headers: {
+      accept: "application/json",
+      "x-api-key": preferences.apiToken,
+    },
+  }).then((res) => res.json() as Promise<Card>);
+}
+
+export async function runQuestion(input: { questionId: number }) {
+  const endpoint = new URL(`/api/card/${input.questionId}/query`, preferences.instanceUrl);
+
+  return fetch(endpoint.toString(), {
+    method: "POST",
+    headers: {
+      accept: "application/json",
+      contentType: "application/json",
+      "x-api-key": preferences.apiToken,
+    },
+    body: JSON.stringify({}),
+  }).then((res) => res.json() as Promise<{ data: Query }>);
+}
+
+export async function getDatabases() {
+  const endpoint = new URL("/api/database", preferences.instanceUrl);
+
+  endpoint.searchParams.set("include", "tables");
+
+  return fetch(endpoint.toString(), {
+    method: "GET",
+    headers: {
+      accept: "application/json",
+      "x-api-key": preferences.apiToken,
+    },
+  })
+    .then((res) => res.json() as Promise<{ data: Database[] }>)
+    .then((res) => res.data);
+}
+
+export async function getDatabase(databaseId: number) {
+  const endpoint = new URL(`/api/database/${databaseId}`, preferences.instanceUrl);
+
+  return fetch(endpoint.toString(), {
+    method: "GET",
+    headers: {
+      accept: "application/json",
+      "x-api-key": preferences.apiToken,
+    },
+  }).then((res) => res.json() as Promise<Database>);
+}
+
+export async function getQuestions() {
+  const endpoint = new URL("/api/card", preferences.instanceUrl);
+
+  return fetch(endpoint.toString(), {
+    method: "GET",
+    headers: {
+      accept: "application/json",
+      "x-api-key": preferences.apiToken,
+    },
+  }).then((res) => res.json() as Promise<Card[]>);
+}