supabase · 129 tools · no triggers
Connect it
run auth supabase
run auth supabase --scope team # shared with the organization
Use it
run supabase # common commands
run supabase --all # every command
import { supabase } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
apply-migration | Tool to apply database migrations to a Supabase project. Use when you need to execute SQL schema changes, create tables, alter columns, or run other… |
beta-run-sql-query | Executes a given SQL query against the project’s database; use for advanced data operations or when standard API endpoints are insufficient, ensuring… |
create-project | Creates a new Supabase project, requiring a unique name (no dots) within the organization; project creation is asynchronous. |
create-bulk-secrets | Tool to bulk create secrets for a Supabase project. Use when you need to create multiple project secrets at once. |
create-function | Creates a new serverless Edge Function for a Supabase project (identified by ref), requiring valid JavaScript/TypeScript in body and a… |
create-organization | Creates a new Supabase organization, which serves as a top-level container for projects, billing, and team access. |
create-project-signing-key | Create a new signing key for JWT authentication in a Supabase project. |
delete-project | Permanently and irreversibly deletes a Supabase project and all associated resources, including databases, storage, and configurations. |
deploy-function | Deploys Edge Functions to a Supabase project using multipart upload. |
generate-typescript-types | Generates and retrieves TypeScript types from a Supabase project’s database; any schemas specified in included_schemas must exist in the project. |
get-auth-config | Retrieves the complete authentication configuration for a Supabase project. |
get-function | Retrieves detailed information, metadata, configuration, and status for a specific Edge Function using its project reference ID and function slug. |
get-function-body | Retrieves the source code (body) for a specified serverless Edge Function using its project reference and function slug; this is a read-only… |
get-project | Retrieves detailed information about a specific Supabase project by its unique reference ID. |
get-project-api-keys | Retrieves all API keys for an existing Supabase project, specified by its unique reference ID (ref); this is a read-only operation. |
get-project-logs | Retrieves analytics logs for a Supabase project. Use this to fetch and analyze project logs including edge function logs, database logs, and API logs… |
get-project-signing-keys | Tool to list all signing keys for a Supabase project. Use when you need to retrieve JWT signing keys for authentication verification or rotation management. |
gets-project-s-service-health-status | Retrieves the current health status for a Supabase project, for specified services or all services if the ‘services’ list is omitted. |
get-table-schemas | Retrieves column details, types, and constraints for multiple database tables to help debug schema issues and write accurate SQL queries. |
invoke-edge-function | Tool to invoke a deployed Supabase Edge Function over HTTPS. |
list-all-organizations | Lists all organizations (ID and name only) associated with the Supabase account, excluding project details within these organizations. |
list-all-projects | Retrieves a list of all Supabase projects, including their ID, name, region, and status, for the authenticated user. |
list-branches | Lists all database branches for a specified Supabase project, providing information about each branch’s status, configuration, and metadata. |
list-buckets | Retrieves a list of all storage buckets for a Supabase project, without returning bucket contents or access policies. |
list-functions | Lists metadata for all Edge Functions in a Supabase project (specified by ‘ref’), excluding function code or logs; the project must exist. |
All 129 tools
All 129 tools
| Tool | What it does |
|---|---|
alpha-create-api-key | Creates a ‘publishable’ or ‘secret’ API key for an existing Supabase project, optionally with a description; ‘secret’ keys can have customized JWT templates. |
alpha-delete-api-key | Permanently deletes a specific API key (identified by id) from a Supabase project (identified by ref), revoking its access. |
alpha-delete-third-party-auth-integration | Removes a third-party authentication provider (e.g., Google, GitHub) from a Supabase project’s configuration; this immediately prevents users from… |
alpha-get-third-party-integration | Retrieves the detailed configuration for a specific third-party authentication (TPA) provider, identified by tpa_id, within an existing Supabase… |
alpha-list-third-party-auth-integrations | Lists all configured third-party authentication provider integrations for an existing Supabase project (using its ref), suitable for read-only… |
alpha-update-api-key | Updates an existing Supabase project API key’s description and/or secret_jwt_template (which defines its role); does not regenerate the key string. |
apply-migration | Tool to apply database migrations to a Supabase project. Use when you need to execute SQL schema changes, create tables, alter columns, or run other… |
beta-activate-custom-hostname | Activates a previously configured custom hostname for a Supabase project, assuming DNS settings are verified externally. |
beta-activate-vanity-subdomain | Activates a vanity subdomain for the specified Supabase project (e.g., ‘my-brand.supabase.co’). |
beta-authorize-user-through-oauth | Generates a Supabase OAuth 2.0 authorization URL for user redirection. |
beta-check-vanity-subdomain-availability | Checks if a specific vanity subdomain is available for a Supabase project; this action does not reserve or assign the subdomain. |
beta-create-read-replica | Provisions a read-only replica for a Supabase project in a specified, Supabase-supported AWS region to enhance read performance and reduce latency. |
beta-enable-database-webhooks | Enables database webhooks for the Supabase project ref, triggering real-time notifications for INSERT, UPDATE, or DELETE events. |
beta-get-project-custom-hostname-config | Retrieves a Supabase project’s custom hostname configuration, including its status, SSL certificate, and ownership verification, noting that… |
beta-get-project-network-bans | Retrieves the list of banned IPv4 addresses for a Supabase project using its unique project reference string; this is a read-only operation. |
beta-get-project-network-restrictions | Retrieves the network restriction settings (IP allowlists) for a Supabase project. |
beta-get-project-pgsodium-config | Retrieves the PGSodium configuration, including the root encryption key, for an existing Supabase project identified by its ref. |
beta-get-project-ssl-enforcement-config | Retrieves the SSL enforcement configuration for a specified Supabase project, indicating if SSL connections are mandated for its database. |
beta-get-vanity-subdomain-config | Fetches the current vanity subdomain configuration, including its status and custom domain name, for a Supabase project identified by its reference ID. |
beta-remove-network-bans | Removes specified IPv4 addresses from a Supabase project’s network ban list, granting immediate access; IPs not currently banned are ignored. |
beta-remove-read-replica | Remove a read replica from a Supabase project (Pro plan or higher required). |
beta-run-sql-query | Executes a given SQL query against the project’s database; use for advanced data operations or when standard API endpoints are insufficient, ensuring… |
beta-update-project-network-restrictions | Updates and applies network access restrictions (IPv4/IPv6 CIDR lists) for a Supabase project, which may terminate existing connections not matching the new rules. |
beta-upgrade-project-postgres-version | Initiates an asynchronous upgrade of a Supabase project’s PostgreSQL database to a specified target_version from a selected release_channel… |
count-action-runs | Counts the number of action runs for a Supabase project using a HEAD request. |
create-project | Creates a new Supabase project, requiring a unique name (no dots) within the organization; project creation is asynchronous. |
create-bulk-secrets | Tool to bulk create secrets for a Supabase project. Use when you need to create multiple project secrets at once. |
create-database-branch | Creates a new, isolated database branch from an existing Supabase project (identified by ref), useful for setting up separate environments like… |
create-function | Creates a new serverless Edge Function for a Supabase project (identified by ref), requiring valid JavaScript/TypeScript in body and a… |
create-login-role | Creates a temporary CLI login role for database access with specified permissions; use when setting up CLI authentication for development or administrative tasks. |
create-organization | Creates a new Supabase organization, which serves as a top-level container for projects, billing, and team access. |
create-project-signing-key | Create a new signing key for JWT authentication in a Supabase project. |
create-sso-provider | Creates a new SAML 2.0 Single Sign-On (SSO) provider for a Supabase project, requiring either metadata_xml or metadata_url for SAML IdP configuration. |
create-third-party-auth-integration | Call this to add a new third-party authentication method (OIDC or JWKS) to a Supabase project for integrating external identity providers (e.g., for… |
delete-all-branches | Disables preview branching for a Supabase project, which deletes all remaining branches. |
delete-custom-hostname-config | Deletes an active custom hostname configuration for the project identified by ref, reverting to the default Supabase-provided hostname; this action… |
delete-database-branch | Permanently and irreversibly deletes a specific, non-default database branch by its branch_id, without affecting other branches. |
delete-edge-function | Deletes an Edge Function from a Supabase project by its slug. |
delete-function | Permanently deletes a specific Edge Function (by function_slug) from a Supabase project (by ref); this action is irreversible and requires prior… |
delete-login-roles | [Beta] Deletes existing login roles used by the Supabase CLI for the specified project. |
delete-project | Permanently and irreversibly deletes a Supabase project and all associated resources, including databases, storage, and configurations. |
delete-project-vanity-subdomain | Permanently and irreversibly deletes an active vanity subdomain configuration for the specified Supabase project, reverting it to its default Supabase URL. |
delete-secrets | Deletes one or more secrets from a Supabase project by their names. |
delete-sso-provider | Deletes a specific SSO provider by its ID (provider_id) from a Supabase project (ref), which disables it and returns its details; ensure this… |
deploy-function | Deploys Edge Functions to a Supabase project using multipart upload. |
disable-preview-branching | Disables the preview branching feature for an existing Supabase project, identified by its unique reference ID (ref). |
disable-project-readonly | Temporarily disables a Supabase project’s read-only mode for 15 minutes to allow write operations (e.g., for maintenance or critical updates), after… |
exchange-oauth-token | (Beta) Implements the OAuth 2.0 token endpoint to exchange an authorization code or refresh token for access/refresh tokens, based on grant_type. |
generate-typescript-types | Generates and retrieves TypeScript types from a Supabase project’s database; any schemas specified in included_schemas must exist in the project. |
get-action-run | Retrieves the status and details of a specific action run, including its steps, timestamps, and configuration. |
get-action-run-logs | Retrieves the execution logs for a specific action run by its ID. |
get-auth-config | Retrieves the complete authentication configuration for a Supabase project. |
get-available-regions | Tool to get the list of available regions for creating a new Supabase project. |
get-branch | Retrieves detailed information about a specific database branch by its name and project reference. |
get-database-branch-config | Retrieves the read-only configuration and status for a Supabase database branch, typically for monitoring or verifying its settings. |
get-database-metadata | Gets database metadata for the given project. Returns information about databases, schemas, and tables structure. |
get-function | Retrieves detailed information, metadata, configuration, and status for a specific Edge Function using its project reference ID and function slug. |
get-function-body | Retrieves the source code (body) for a specified serverless Edge Function using its project reference and function slug; this is a read-only… |
get-health | Tool to check the health status of the Supabase API. Use when you need to verify API availability or troubleshoot connectivity issues. |
get-jit-access-config | [Beta] Retrieves the project’s just-in-time (JIT) access configuration, including user roles and their expiration settings. |
get-legacy-signing-key | Retrieves the signing key information for the JWT secret imported as signing key for this project. |
get-migration | Retrieves a specific database migration entry from the migration history using its version identifier. |
get-organization | Fetches comprehensive details for a specific Supabase organization using its unique slug. |
get-performance-advisors | Retrieves project performance advisors for a Supabase project. |
get-project | Retrieves detailed information about a specific Supabase project by its unique reference ID. |
get-project-api-key | Retrieves details of a specific API key for a Supabase project by its UUID. |
get-project-api-keys | Retrieves all API keys for an existing Supabase project, specified by its unique reference ID (ref); this is a read-only operation. |
get-project-legacy-api-keys | Checks whether JWT-based legacy API keys (anon, service_role) are enabled for a Supabase project. |
get-project-logs | Retrieves analytics logs for a Supabase project. Use this to fetch and analyze project logs including edge function logs, database logs, and API logs… |
get-project-pgbouncer-config | Retrieves the active PgBouncer configuration (PostgreSQL connection pooler) for a Supabase project, used for performance tuning, auditing, or getting… |
get-project-postgres-config | Retrieves the current read-only PostgreSQL database configuration for a specified Supabase project’s ref, noting that some advanced or… |
get-project-postgrest-config | Retrieves the PostgREST configuration for a specific Supabase project. |
get-project-readonly-mode-status | Retrieves the read-only mode status for a specified Supabase project to check its operational state; this action does not change the read-only state. |
get-project-signing-keys | Tool to list all signing keys for a Supabase project. Use when you need to retrieve JWT signing keys for authentication verification or rotation management. |
get-project-supavisor-config | Retrieves the Supavisor (connection pooler) configuration for a specified Supabase project, identified by its reference ID. |
get-project-upgrade-eligibility | Checks a Supabase project’s eligibility for an upgrade, verifying compatibility and identifying potential issues; this action does not perform the actual upgrade. |
get-project-upgrade-status | Retrieves the latest status of a Supabase project’s database upgrade for monitoring purposes; does not initiate or modify upgrades. |
get-resumable-upload-base-options | Handles OPTIONS request for TUS Resumable uploads to discover server capabilities. |
get-resumable-upload-options | Handles OPTIONS request for TUS Resumable uploads to discover server capabilities. |
get-security-advisors | Retrieves security advisor findings and recommendations for a Supabase project. |
gets-project-s-auth-config | Retrieves the project’s complete read-only authentication configuration, detailing all settings (e.g., providers, MFA, email/SMS, JWT, security… |
gets-project-s-service-health-status | Retrieves the current health status for a Supabase project, for specified services or all services if the ‘services’ list is omitted. |
get-sql-snippet | Retrieves a specific SQL snippet by its unique identifier. |
get-sso-provider | Retrieves the configuration details for a specific Single Sign-On (SSO) provider (e.g., SAML, Google, GitHub, Azure AD), identified by its UUID… |
get-table-schemas | Retrieves column details, types, and constraints for multiple database tables to help debug schema issues and write accurate SQL queries. |
handle-resumable-upload-sign-options | Handles CORS preflight OPTIONS request for TUS resumable upload signing. |
handle-resumable-upload-sign-options-with-id | Handles CORS preflight OPTIONS request for TUS resumable upload signing endpoints. |
invoke-edge-function | Tool to invoke a deployed Supabase Edge Function over HTTPS. |
list-all-organizations | Lists all organizations (ID and name only) associated with the Supabase account, excluding project details within these organizations. |
list-all-projects | Retrieves a list of all Supabase projects, including their ID, name, region, and status, for the authenticated user. |
list-backups | Lists all database backups for a Supabase project, providing details on existing backups but not creating new ones or performing restores… |
list-branches | Lists all database branches for a specified Supabase project, providing information about each branch’s status, configuration, and metadata. |
list-buckets | Retrieves a list of all storage buckets for a Supabase project, without returning bucket contents or access policies. |
list-database-branches | Lists all database branches for a specified Supabase project, used for isolated development and testing of schema changes; ensure the project reference ID is valid. |
list-functions | Lists metadata for all Edge Functions in a Supabase project (specified by ‘ref’), excluding function code or logs; the project must exist. |
list-migration-history | Retrieves the list of applied database migration versions for a Supabase project. |
list-organization-members | Retrieves all members of a Supabase organization, identified by its unique slug, including their user ID, username, email, role, and MFA status. |
list-project-secrets | Retrieves all secrets (environment variables) for a Supabase project by its reference ID. |
list-secrets | Retrieves all secrets for a Supabase project using its reference ID; secret values in the response may be masked. |
list-sql-snippets | Retrieves a list of SQL snippets for the logged-in user, optionally filtered by a specific Supabase project if project_ref is provided. |
list-sso-providers | Lists all configured Single Sign-On (SSO) providers for a Supabase project, requiring the project reference ID (ref) of an existing project. |
list-tables | Lists all tables and views in specified database schemas, providing a quick overview of database structure to help identify available tables before… |
merge-branch | Merges a database branch, applying all schema changes and migrations from the branch to the target database. |
patch-migration | [Beta] Patches an existing entry in the project’s migration history, updating the name or rollback script. |
patch-network-restrictions | Updates project’s network restrictions by incrementally adding or removing IPv4/IPv6 CIDR blocks. |
push-branch | Pushes a database branch, applying migrations and changes to the specified branch. |
reset-database-branch | Resets an existing Supabase database branch, identified by branch_id, to its initial clean state, irreversibly deleting all its current data and schema changes. |
restore-pitr-backup | Restores a Supabase project’s database to a specific Unix timestamp using Point-in-Time Recovery (PITR), overwriting the current state; requires a… |
run-read-only-query | [Beta] Run a SQL query as supabase_read_only_user. Use when you need to safely execute SELECT queries without risk of modifying data. |
select-from-table | Tool to select rows from a Supabase/PostgREST table. Use for read-only queries with filtering, sorting, and pagination. |
update-function | Updates an existing Supabase Edge Function’s properties (like name, slug, source code, JWT settings, import map) identified by project ref and… |
update-api-key | Updates an existing Supabase project API key’s metadata including name, description, and JWT template configuration. |
update-branch | Updates the configuration of a Supabase database branch, allowing modification of its name, associated Git branch, notification URL, persistence settings, and status. |
update-database-branch-config | Updates the configuration of a Supabase database branch, allowing modification of its name, associated Git branch, reset-on-push behavior, persistence, and status. |
update-database-password | Updates the database password for a Supabase project. Use when needing to rotate credentials or recover database access. |
update-functions | Tool to bulk update Edge Functions in a Supabase project. Use when you need to update multiple functions at once with new configurations such as… |
update-jit-access-config | [Beta] Update a Supabase project’s just-in-time (JIT) access configuration. |
update-pgsodium-config | Critically updates or initializes a Supabase project’s pgsodium root encryption key for security setup or key rotation, requiring secure backup of… |
update-project | Updates a Supabase project’s configuration (currently supports updating the project name). |
update-project-auth-config | Update Supabase project Auth configuration via the Management API. |
update-project-custom-hostname | Updates the custom hostname for a Supabase project, requiring subsequent DNS changes to a user-controlled domain for SSL certificate issuance and domain ownership. |
update-project-legacy-api-keys | Tool to disable or re-enable JWT-based legacy API keys (anon, service_role) for a Supabase project. |
update-project-postgres-config | Updates specified PostgreSQL configuration parameters for an existing Supabase project (ref) to optimize database performance; note that… |
update-project-postgrest-config | Updates PostgREST configuration settings (e.g., max_rows, db_pool, db_schema, db_extra_search_path) for a Supabase project to fine-tune API… |
update-project-supavisor-config | Updates the Supavisor (database pooler) configuration, such as default_pool_size, for an existing Supabase project identified by ref; the… |
update-ssl-enforcement-config | Updates the SSL enforcement configuration (enable/disable) for a specified Supabase project’s database. |
update-sso-provider | Updates an existing SSO provider’s SAML metadata, associated email domains, or attribute mappings for a Supabase project, identified by ref and provider_id. |
upsert-migration | Tool to upsert a database migration without applying it. Use when you need to track migration changes for a project. [Beta] This endpoint stores… |
verify-custom-hostname-dns | Re-verifies DNS and SSL configurations for an existing custom hostname associated with a Supabase project. |