Merge pull request #12 from supabase-community/feat/project-pause-restore

Project pause and restore tools

Author: gregnr

README.md

@@ -4,7 +4,7 @@
 
 ![supabase-mcp-demo](https://github.com/user-attachments/assets/3fce101a-b7d4-482f-9182-0be70ed1ad56)
 
-The [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) standardizes how Large Language Models (LLMs) talk to external services like Supabase. It connects AI assistants directly with your Supabase project and allows them to perform tasks like managing tables, fetching config, and querying data.
+The [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) standardizes how Large Language Models (LLMs) talk to external services like Supabase. It connects AI assistants directly with your Supabase project and allows them to perform tasks like managing tables, fetching config, and querying data. See the [full list of tools](#tools).
 
 ## Prerequisites
 
@@ -113,17 +113,19 @@ Make sure Node.js is available in your system `PATH` environment variable. If yo
 
 ## Tools
 
-_**Note:** This server is currently pre-1.0, so expect some breaking changes between versions. Since LLMs will automatically adapt to the tools available, this shouldn't affect most users._
+_**Note:** This server is pre-1.0, so expect some breaking changes between versions. Since LLMs will automatically adapt to the tools available, this shouldn't affect most users._
 
 The following Supabase tools are available to the LLM:
 
 #### Project Management
 
 - `list_projects`: Lists all Supabase projects for the user.
-- `get_project`: Gets a project by ID.
+- `get_project`: Gets details for a project.
 - `create_project`: Creates a new Supabase project.
-- `list_organizations`: Lists all organizations for the user.
-- `get_organization`: Gets an organization by ID.
+- `pause_project`: Pauses a project.
+- `restore_project`: Restores a project.
+- `list_organizations`: Lists all organizations that the user is a member of.
+- `get_organization`: Gets details for an organization.
 
 #### Database Operations
 

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

@@ -85,7 +85,7 @@ async function setup(options: SetupOptions = {}) {
     const [textContent] = content;
 
     if (!textContent) {
-      throw new Error('tool result content is missing');
+      return undefined;
     }
 
     if (textContent.type !== 'text') {
@@ -215,6 +215,32 @@ describe('tools', () => {
     });
   });
 
+  test('pause project', async () => {
+    const { callTool } = await setup();
+    const project = mockProjects.values().next().value!;
+    await callTool({
+      name: 'pause_project',
+      arguments: {
+        project_id: project.id,
+      },
+    });
+
+    expect(project.status).toEqual('INACTIVE');
+  });
+
+  test('restore project', async () => {
+    const { callTool } = await setup();
+    const project = mockProjects.values().next().value!;
+    await callTool({
+      name: 'restore_project',
+      arguments: {
+        project_id: project.id,
+      },
+    });
+
+    expect(project.status).toEqual('ACTIVE_HEALTHY');
+  });
+
   test('get project url', async () => {
     const { callTool } = await setup();
     const project = mockProjects.values().next().value!;

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

@@ -103,7 +103,7 @@ export function createSupabaseMcpServer(options: SupabaseMcpServerOptions) {
         },
       }),
       get_project: tool({
-        description: 'Gets a project by ID.',
+        description: 'Gets details for a Supabase project.',
         parameters: z.object({
           id: z.string().describe('The project ID'),
         }),
@@ -153,8 +153,49 @@ export function createSupabaseMcpServer(options: SupabaseMcpServerOptions) {
           return response.data;
         },
       }),
+      pause_project: tool({
+        description: 'Pauses a Supabase project.',
+        parameters: z.object({
+          project_id: z.string(),
+        }),
+        execute: async ({ project_id }) => {
+          const response = await managementApiClient.POST(
+            '/v1/projects/{ref}/pause',
+            {
+              params: {
+                path: {
+                  ref: project_id,
+                },
+              },
+            }
+          );
+
+          assertSuccess(response, 'Failed to pause project');
+        },
+      }),
+      restore_project: tool({
+        description: 'Restores a Supabase project.',
+        parameters: z.object({
+          project_id: z.string(),
+        }),
+        execute: async ({ project_id }) => {
+          const response = await managementApiClient.POST(
+            '/v1/projects/{ref}/restore',
+            {
+              params: {
+                path: {
+                  ref: project_id,
+                },
+              },
+              body: {},
+            }
+          );
+
+          assertSuccess(response, 'Failed to restore project');
+        },
+      }),
       list_organizations: tool({
-        description: 'Lists all organizations for the user.',
+        description: 'Lists all organizations that the user is a member of.',
         parameters: z.object({}),
         execute: async () => {
           const response = await managementApiClient.GET('/v1/organizations');
@@ -165,7 +206,8 @@ export function createSupabaseMcpServer(options: SupabaseMcpServerOptions) {
         },
       }),
       get_organization: tool({
-        description: 'Gets an organization by ID.',
+        description:
+          'Gets details for an organization. Includes subscription plan.',
         parameters: z.object({
           id: z.string().describe('The organization ID'),
         }),

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

@@ -98,6 +98,36 @@ export const mockManagementApi = [
     return HttpResponse.json(projectResponse);
   }),
 
+  http.post<{ projectId: string }>(
+    `${API_URL}/v1/projects/:projectId/pause`,
+    ({ params }) => {
+      const project = mockProjects.get(params.projectId);
+      if (!project) {
+        return HttpResponse.json(
+          { error: 'Project not found' },
+          { status: 404 }
+        );
+      }
+      project.status = 'INACTIVE';
+      return HttpResponse.json(project.details);
+    }
+  ),
+
+  http.post<{ projectId: string }>(
+    `${API_URL}/v1/projects/:projectId/restore`,
+    ({ params }) => {
+      const project = mockProjects.get(params.projectId);
+      if (!project) {
+        return HttpResponse.json(
+          { error: 'Project not found' },
+          { status: 404 }
+        );
+      }
+      project.status = 'ACTIVE_HEALTHY';
+      return HttpResponse.json(project.details);
+    }
+  ),
+
   http.get(`${API_URL}/v1/organizations`, () => {
     return HttpResponse.json(mockOrgs);
   }),