> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Grafbase

> Grafbase is a platform that accelerates the development of GraphQL APIs, offering features like edge caching, unified data access, and seamless integration with popular authentication strategies.

![Grafbase logo](https://mintcdn.com/composio-preview/o1IUBrrsmtgkhmyf/images/toolkits/grafbase.ico?fit=max\&auto=format\&n=o1IUBrrsmtgkhmyf\&q=85\&s=1686bce7a278aa73fa874f73c8e57c8d)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 28
* **Triggers:** 0
* **Slug:** `GRAFBASE`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Zitadel Redirect URI
>
> **Slug:** `GRAFBASE_ADD_ZITADEL_REDIRECT`
>
> Request addition of a Zitadel OAuth redirect in Grafbase using the authenticated context. The action accepts no redirect URI input and reports the mutation outcome.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Assign Team Role
>
> **Slug:** `GRAFBASE_ASSIGN_TEAM_ROLE`
>
> Tool to assign a role to a team member in Grafbase. Use this when you need to change a team member's role between MEMBER and ADMIN. ADMIN role grants team management privileges including adding/removing members and changing roles.
>
> #### Input Parameters
>
> **role** `string ("MEMBER" | "ADMIN")` *required*
>
> Role to assign to the team member. MEMBER grants standard access, ADMIN grants administrative privileges including team management.
>
> **team\_id** `string` *required*
>
> Unique identifier of the team. Must be a valid Grafbase team ID.
>
> **member\_id** `string` *required*
>
> Unique identifier of the member to assign the role to. Must be a valid Grafbase user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Grafbase API Key
>
> **Slug:** `GRAFBASE_DELETE_API_KEY`
>
> Delete a Grafbase API key (access token) by ID. The action reports success when the deletion result is present, including when it is null, so success does not necessarily confirm revocation.
>
> #### Input Parameters
>
> **key\_id** `string` *required*
>
> The unique identifier of the Grafbase API key (access token) to delete. Obtain this ID by first listing API keys using the List API Keys action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Grafbase Audit Log
>
> **Slug:** `GRAFBASE_DELETE_AUDIT_LOG`
>
> Tool to delete a specific Grafbase audit log entry. IMPORTANT: Grafbase does not expose a public API to delete audit logs. Audit logs are read-only compliance records retained for 90 days and can only be exported as CSV from the Grafbase Dashboard. This action validates connectivity to the Grafbase API and returns an informative response about this limitation.
>
> #### Input Parameters
>
> **log\_id** `string` *required*
>
> The unique identifier of the audit log entry to delete. Note: Grafbase audit logs cannot be deleted via API - they are retained for 90 days and only exportable via CSV from the dashboard.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Extension
>
> **Slug:** `GRAFBASE_DELETE_EXTENSION`
>
> Attempt to delete a Grafbase extension configuration by its unique ID through the project API. The action can return guidance for removing the extension through configuration.
>
> #### Input Parameters
>
> **extension\_id** `string` *required*
>
> The unique identifier of the extension to delete. Note: Grafbase extensions are typically configured via grafbase.toml, not via REST API. This action attempts to delete via API if supported, otherwise returns guidance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete MCP Server
>
> **Slug:** `GRAFBASE_DELETE_MCP_SERVER`
>
> Attempt to delete a Grafbase MCP server configuration by its unique ID through the project API. The action can return guidance for disabling MCP through configuration.
>
> #### Input Parameters
>
> **server\_id** `string` *required*
>
> The unique identifier of the MCP server configuration to delete. Note: Grafbase MCP is typically configured via grafbase.toml, not via REST API. This action attempts to delete via API if supported, otherwise returns guidance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Grafbase Subgraph
>
> **Slug:** `GRAFBASE_DELETE_SCHEMA`
>
> Tool to delete a subgraph from a Grafbase federated graph. Use this when you need to remove a subgraph from the schema registry. The operation can be run as a dry run first to check if deletion would cause composition errors in the federated graph. Required: account\_slug, subgraph\_name Optional: branch (defaults to 'main'), graph\_slug, message, dry\_run
>
> #### Input Parameters
>
> **branch** `string`
>
> The branch name where the subgraph exists (defaults to 'main')
>
> **dry\_run** `boolean`
>
> If True, validates the deletion without actually removing the subgraph. Useful for checking composition impact.
>
> **message** `string`
>
> Optional message describing the reason for deletion
>
> **graph\_slug** `string`
>
> Optional graph slug if the account has multiple graphs
>
> **account\_slug** `string` *required*
>
> The organization/account slug that owns the graph (e.g., 'my-organization')
>
> **subgraph\_name** `string` *required*
>
> The name of the subgraph to delete from the federated graph
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Schema Check
>
> **Slug:** `GRAFBASE_DELETE_SCHEMA_CHECK`
>
> Query a Grafbase schema check by ID and return information about the check or an API error. This action does not delete the check and reports deletion as unsupported.
>
> #### Input Parameters
>
> **check\_id** `string` *required*
>
> The unique identifier of the schema check. Note: Grafbase does not support deleting schema checks as they are immutable audit records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Grafbase Team
>
> **Slug:** `GRAFBASE_DELETE_TEAM`
>
> Tool to delete a team from the Grafbase organization. Use when removing a team that is no longer needed. This action permanently removes the team and its associated permissions.
>
> #### Input Parameters
>
> **team\_id** `string` *required*
>
> The unique identifier of the team to delete. Must be a valid CompositeID format (e.g., 'team\_01KFQJ7YT4PSP01A09ACVTR899').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Disable MCP Server
>
> **Slug:** `GRAFBASE_DISABLE_MCP`
>
> Attempt to disable the Model Context Protocol (MCP) server for a Grafbase project through its API. The action can return configuration guidance. Dry-run does not prevent the disabling request, so it can still change the server.
>
> #### Input Parameters
>
> **reason** `string`
>
> Optional reason for disabling MCP; included in the response message for audit/logging purposes.
>
> **dry\_run** `boolean`
>
> If true, simulates the disable action without making changes. The API call is still executed but response indicates dry-run mode.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Enable Grafbase MCP Server
>
> **Slug:** `GRAFBASE_ENABLE_MCP`
>
> Attempt to enable MCP on a Grafbase gateway via its API, returning manual configuration guidance if the endpoint is unsupported or unreachable. A dry-run request still sends the API request and may change the gateway.
>
> #### Input Parameters
>
> **reason** `string`
>
> Optional reason or context for enabling MCP. Used for logging and message annotation only.
>
> **dry\_run** `boolean`
>
> If true, indicates a dry run intent. The API call is still executed but this flag is logged for reference.
>
> **enabled** `boolean`
>
> Target enabled state (true to enable, false to disable). If not provided, the default enable behavior is used.
>
> **server\_url** `string`
>
> Optional custom MCP server URL to configure. If provided, it may be sent in the request body if the endpoint accepts it.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Grafbase Audit Log
>
> **Slug:** `GRAFBASE_GET_AUDIT_LOG`
>
> Search accessible Grafbase organization members by user ID, name, email, or role, optionally scoped to an organization. Returns the first matching member as a synthetic member\_info entry, not an audit event; the search also matches the terms member and organization.
>
> #### Input Parameters
>
> **log\_id** `string` *required*
>
> Identifier for the audit log entry to retrieve. Can be a timestamp, user ID, or action type to search for.
>
> **organization\_slug** `string`
>
> Organization slug to scope the audit log search (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Extension by Name
>
> **Slug:** `GRAFBASE_GET_EXTENSION_BY_NAME`
>
> Tool to retrieve a Grafbase extension by its name. Returns detailed information including the extension's ID, name, versions, and ownership details. Use this when you need to look up an extension by name rather than ID.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the extension to retrieve (e.g., 'postgres', 'auth0', 'stripe')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Extension Version By Name And Version
>
> **Slug:** `GRAFBASE_GET_EXTENSION_VERSION_BY_NAME_AND_VERSION`
>
> Tool to retrieve details of a specific Grafbase extension version by name and version. Use when you need to query information about a particular version of an extension, including its creation date and license.
>
> #### Input Parameters
>
> **version** `string` *required*
>
> The semantic version of the extension (e.g., '0.6.1')
>
> **extension\_name** `string` *required*
>
> The name of the extension (e.g., 'postgres', 'mongodb')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Federated Schema
>
> **Slug:** `GRAFBASE_GET_FEDERATED_SCHEMA`
>
> Retrieves the composed federated graph schema from Grafbase in SDL format. Use this to inspect the unified schema after all subgraph schemas have been composed. Returns the full GraphQL SDL including all types, queries, mutations, and subscriptions. Requires at least one federated graph with published subgraphs to return a schema.
>
> #### Input Parameters
>
> **branch** `string`
>
> Branch name to retrieve the federated schema for (defaults to 'main' if not provided)
>
> **graph\_slug** `string`
>
> Slug identifier of the federated graph (e.g., 'my-graph'). If not provided, returns the schema from the first available graph.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Grafbase Invitation
>
> **Slug:** `GRAFBASE_GET_INVITATION`
>
> Retrieve details of a specific Grafbase invitation by ID, including its status, email address, and creation date. The result indicates whether the invitation was found.
>
> #### Input Parameters
>
> **invitation\_id** `string` *required*
>
> The unique identifier of the invitation to retrieve. Uses CompositeID format (e.g., '01KFQJ7YT4PSP01A09ACVTR899').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Notifications Inbox Messages
>
> **Slug:** `GRAFBASE_GET_NOTIFICATIONS_INBOX_MESSAGES`
>
> Tool to retrieve notifications inbox messages for the authenticated Grafbase user. Returns all notification messages with counts of total and unread notifications. Use when you need to check for new notifications or see notification history.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Grafbase Schema Check
>
> **Slug:** `GRAFBASE_GET_SCHEMA_CHECK`
>
> Retrieve a Grafbase schema check by ID within an account and graph, returning its error count, subgraph name and available Git commit information. Searches only the first 100 checks returned for the graph.
>
> #### Input Parameters
>
> **check\_id** `string` *required*
>
> The unique ID of the schema check to retrieve. Obtain this from list\_schema\_checks action.
>
> **graph\_slug** `string` *required*
>
> The slug of the graph within the account (e.g., 'my-graph')
>
> **account\_slug** `string` *required*
>
> The slug of the Grafbase account/organization (e.g., 'my-org')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subgraph Schema
>
> **Slug:** `GRAFBASE_GET_SUBGRAPH_SCHEMA`
>
> Retrieve the GraphQL SDL schema for a subgraph by name. Searches accessible organizations, graphs and branches and returns the first matching subgraph with a nonempty schema.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The unique name of the subgraph to retrieve the schema for. Use GRAFBASE\_LIST\_SUBGRAPHS to discover available subgraph names first.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List API Keys
>
> **Slug:** `GRAFBASE_LIST_API_KEYS`
>
> List all API keys (access tokens) for the authenticated Grafbase user. Uses the Grafbase Management API to retrieve access tokens with pagination support.
>
> #### Input Parameters
>
> **last** `integer`
>
> Number of API keys to return from the end of the list (backward pagination). Max 100.
>
> **after** `string`
>
> Cursor for forward pagination. Return items after this cursor.
>
> **first** `integer`
>
> Number of API keys to return from the beginning of the list (forward pagination). Max 100.
>
> **before** `string`
>
> Cursor for backward pagination. Return items before this cursor.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Grafbase Audit Logs
>
> **Slug:** `GRAFBASE_LIST_AUDIT_LOGS`
>
> List Grafbase organization member-join activity derived from organization membership data, with optional organization filtering. Pagination applies to organizations, not individual activity entries; the response may include a note about full audit log access.
>
> #### Input Parameters
>
> **after** `string`
>
> Pagination cursor to fetch logs after this point
>
> **first** `integer`
>
> Maximum number of audit log entries to return (default: 50)
>
> **organization\_slug** `string`
>
> Organization slug to filter audit logs (optional, returns logs from all accessible organizations if not specified)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Extensions
>
> **Slug:** `GRAFBASE_LIST_EXTENSIONS`
>
> List extensions returned by available Grafbase project REST endpoints. If those endpoints are unavailable, the tool may return an empty list with a connectivity message rather than an inventory of configured extensions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List MCP Servers
>
> **Slug:** `GRAFBASE_LIST_MCP_SERVERS`
>
> Check a Grafbase gateway's presumed /mcp endpoint and provide configuration guidance. The reported status is inferred from an HTTP GET response, and the health check can be skipped.
>
> #### Input Parameters
>
> **check\_health** `boolean`
>
> If True, attempts to verify MCP endpoint accessibility. If False, returns configuration guidance without making network requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Grafbase Schema Checks
>
> **Slug:** `GRAFBASE_LIST_SCHEMA_CHECKS`
>
> List schema checks for a Grafbase graph. This tool retrieves the history of schema validation checks that have been run against a specific graph. Schema checks help detect breaking changes before deploying schema updates. Requires account\_slug and graph\_slug to identify the target graph. Supports cursor-based pagination using first/after or last/before parameters.
>
> #### Input Parameters
>
> **last** `integer`
>
> Number of schema checks to return from the end (max 100). Use with 'before' for backward pagination.
>
> **after** `string`
>
> Cursor for forward pagination. Pass the 'endCursor' from a previous response.
>
> **first** `integer`
>
> Number of schema checks to return (max 100). Use with 'after' for pagination.
>
> **before** `string`
>
> Cursor for backward pagination. Pass the 'startCursor' from a previous response.
>
> **branch** `string`
>
> Filter schema checks by branch name (e.g., 'main', 'staging')
>
> **graph\_slug** `string` *required*
>
> The slug of the graph within the account (e.g., 'my-graph')
>
> **account\_slug** `string` *required*
>
> The slug of the Grafbase account/organization (e.g., 'my-org')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Grafbase Schemas
>
> **Slug:** `GRAFBASE_LIST_SCHEMAS`
>
> Tool to list all schemas in the Grafbase schema registry. In Grafbase, the schema registry tracks published subgraphs in federated graphs. Each schema entry represents a subgraph with its name, endpoint URL, and associated graph/branch.
>
> #### Input Parameters
>
> **branch** `string`
>
> Branch name to filter schemas/subgraphs (defaults to showing all branches if not provided)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Grafbase Subgraphs
>
> **Slug:** `GRAFBASE_LIST_SUBGRAPHS`
>
> List published subgraphs and their endpoint URLs across Grafbase organizations, optionally filtering by branch name. An empty result can also be returned when the viewer is unavailable or certain infrastructure errors occur.
>
> #### Input Parameters
>
> **branch** `string`
>
> Branch name to filter subgraphs (e.g., 'main', 'dev'). If not provided, returns subgraphs from all branches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Mark Notifications as Read
>
> **Slug:** `GRAFBASE_MARK_NOTIFICATIONS_AS_READ`
>
> Tool to mark Grafbase notifications as read. Use when you need to update the read status of one or more notifications in your notification inbox.
>
> #### Input Parameters
>
> **notification\_ids** `array` *required*
>
> Array of notification IDs to mark as read. Each ID must be a valid 22-character CompositeID in ULID format (e.g., '01KFQJ7YT4PSP01A09ACVTR899').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Graph Owner
>
> **Slug:** `GRAFBASE_REMOVE_GRAPH_OWNER`
>
> Tool to remove an owner from a Grafbase graph. Use when you need to revoke ownership or access rights for a user or team on a specific graph.
>
> #### Input Parameters
>
> **graph\_id** `string` *required*
>
> The unique identifier of the graph to remove the owner from. This is the graph ID in Grafbase format (e.g., 01KFQJ7YT4PSP01A09ACVTR899).
>
> **owner\_id** `string` *required*
>
> The unique identifier of the owner (user or team) to remove from the graph. This can be a user ID or team ID in Grafbase format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
