Merge pull request #13 from supabase-community/feat/get-logs

get_logs tool call

Author: gregnr

README.md

@@ -134,6 +134,7 @@ The following Supabase tools are available to the LLM:
 - `list_migrations`: Lists all migrations in the database.
 - `apply_migration`: Applies a SQL migration to the database. SQL passed to this tool will be tracked within the database, so LLMs should use this for DDL operations (schema changes).
 - `execute_sql`: Executes raw SQL in the database. LLMs should use this for regular queries that don't change the schema.
+- `get_logs`: Gets logs for a Supabase project by service type (api, postgres, edge functions, auth, storage, realtime). LLMs can use this to help with debugging and monitoring service performance.
 
 #### Project Configuration
 

package-lock.json

@@ -30,6 +30,7 @@
     "@gregnr/postgres-meta": "^0.82.0-dev.2",
     "@modelcontextprotocol/sdk": "^1.4.1",
     "@supabase/mcp-utils": "0.1.1",
+    "common-tags": "^1.8.2",
     "openapi-fetch": "^0.13.4",
     "postgres": "^3.4.5",
     "zod": "^3.24.1",
@@ -38,6 +39,7 @@
   "devDependencies": {
     "@electric-sql/pglite": "^0.2.17",
     "@total-typescript/tsconfig": "^1.0.4",
+    "@types/common-tags": "^1.8.4",
     "@types/node": "^22.8.6",
     "date-fns": "^4.1.0",
     "msw": "^2.7.3",

packages/mcp-server-supabase/package.json

@@ -0,0 +1,60 @@
+import { stripIndent } from 'common-tags';
+
+export function getLogQuery(
+  service:
+    | 'api'
+    | 'postgres'
+    | 'edge-function'
+    | 'auth'
+    | 'storage'
+    | 'realtime',
+  limit: number = 100
+) {
+  switch (service) {
+    case 'api':
+      return stripIndent`
+        select id, identifier, timestamp, event_message, request.method, request.path, response.status_code
+        from edge_logs
+        cross join unnest(metadata) as m
+        cross join unnest(m.request) as request
+        cross join unnest(m.response) as response
+        order by timestamp desc
+        limit ${limit}
+      `;
+    case 'postgres':
+      return stripIndent`
+        select identifier, postgres_logs.timestamp, id, event_message, parsed.error_severity from postgres_logs
+        cross join unnest(metadata) as m
+        cross join unnest(m.parsed) as parsed
+        order by timestamp desc
+        limit ${limit}
+      `;
+    case 'edge-function':
+      return stripIndent`
+        select * from function_logs
+        order by timestamp desc
+        limit ${limit}
+      `;
+    case 'auth':
+      return stripIndent`
+        select id, auth_logs.timestamp, event_message, metadata.level, metadata.status, metadata.path, metadata.msg as msg, metadata.error from auth_logs
+        cross join unnest(metadata) as metadata
+        order by timestamp desc
+        limit ${limit}
+      `;
+    case 'storage':
+      return stripIndent`
+        select id, storage_logs.timestamp, event_message from storage_logs
+        order by timestamp desc
+        limit ${limit}
+      `;
+    case 'realtime':
+      return stripIndent`
+        select id, realtime_logs.timestamp, event_message from realtime_logs
+        order by timestamp desc
+        limit ${limit}
+      `;
+    default:
+      throw new Error(`unsupported log service type: ${service}`);
+  }
+}

packages/mcp-server-supabase/src/logs.ts

@@ -451,6 +451,47 @@ describe('tools', () => {
     );
   });
 
+  test('get logs for each service type', async () => {
+    const { callTool } = await setup();
+    const project = mockProjects.values().next().value!;
+    const services = [
+      'api',
+      'postgres',
+      'edge-function',
+      'auth',
+      'storage',
+      'realtime',
+    ] as const;
+
+    for (const service of services) {
+      const result = await callTool({
+        name: 'get_logs',
+        arguments: {
+          project_id: project.id,
+          service,
+        },
+      });
+
+      expect(result).toEqual([]);
+    }
+  });
+
+  test('get logs for invalid service type', async () => {
+    const { callTool } = await setup();
+    const project = mockProjects.values().next().value!;
+    const invalidService = 'invalid-service';
+    const getLogsPromise = callTool({
+      name: 'get_logs',
+      arguments: {
+        project_id: project.id,
+        service: invalidService,
+      },
+    });
+    await expect(getLogsPromise).rejects.toThrow(
+      `unsupported log service type: invalid-service`
+    );
+  });
+
   test('enable branching', async () => {
     const { callTool } = await setup();
     const project = mockProjects.values().next().value!;

packages/mcp-server-supabase/src/server.test.ts

@@ -6,6 +6,7 @@ import {
 import { createMcpServer, tool } from '@supabase/mcp-utils';
 import { z } from 'zod';
 import { version } from '../package.json';
+import { getLogQuery } from './logs.js';
 import {
   assertSuccess,
   createManagementApiClient,
@@ -328,6 +329,45 @@ export function createSupabaseMcpServer(options: SupabaseMcpServerOptions) {
           return await executeSql(project_id, query);
         },
       }),
+      get_logs: tool({
+        description:
+          'Gets logs for a Supabase project by service type. Use this to help debug problems with your app. This will only return logs within the last minute. If the logs you are looking for are older than 1 minute, re-run your test to reproduce them.',
+        parameters: z.object({
+          project_id: z.string(),
+          service: z
+            .enum([
+              'api',
+              'postgres',
+              'edge-function',
+              'auth',
+              'storage',
+              'realtime',
+            ])
+            .describe('The service to fetch logs for'),
+        }),
+        execute: async ({ project_id, service }) => {
+          const now = Date.now();
+          const response = await managementApiClient.GET(
+            '/v1/projects/{ref}/analytics/endpoints/logs.all',
+            {
+              params: {
+                path: {
+                  ref: project_id,
+                },
+                query: {
+                  // Omitting start and end time defaults to the last minute
+                  sql: getLogQuery(service),
+                },
+              },
+            }
+          );
+
+          assertSuccess(response, 'Failed to fetch logs');
+
+          return response.data;
+        },
+      }),
+
       get_project_url: tool({
         description: 'Gets the API URL for a project.',
         parameters: z.object({