Skip to main content
Grafbase logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 28
  • Triggers: 0
  • Slug: GRAFBASE
  • Version: 20261101_00

Tools

Slug: GRAFBASE_ADD_ZITADEL_REDIRECTRequest 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_ASSIGN_TEAM_ROLETool 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

string ("MEMBER" | "ADMIN")
required
Role to assign to the team member. MEMBER grants standard access, ADMIN grants administrative privileges including team management.
string
required
Unique identifier of the team. Must be a valid Grafbase team ID.
string
required
Unique identifier of the member to assign the role to. Must be a valid Grafbase user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_API_KEYDelete 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_AUDIT_LOGTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_EXTENSIONAttempt 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_MCP_SERVERAttempt 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_SCHEMATool 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

string
The branch name where the subgraph exists (defaults to ‘main’)
boolean
If True, validates the deletion without actually removing the subgraph. Useful for checking composition impact.
string
Optional message describing the reason for deletion
string
Optional graph slug if the account has multiple graphs
string
required
The organization/account slug that owns the graph (e.g., ‘my-organization’)
string
required
The name of the subgraph to delete from the federated graph

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_SCHEMA_CHECKQuery 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

string
required
The unique identifier of the schema check. Note: Grafbase does not support deleting schema checks as they are immutable audit records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DELETE_TEAMTool 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

string
required
The unique identifier of the team to delete. Must be a valid CompositeID format (e.g., ‘team_01KFQJ7YT4PSP01A09ACVTR899’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_DISABLE_MCPAttempt 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

string
Optional reason for disabling MCP; included in the response message for audit/logging purposes.
boolean
If true, simulates the disable action without making changes. The API call is still executed but response indicates dry-run mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_ENABLE_MCPAttempt 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

string
Optional reason or context for enabling MCP. Used for logging and message annotation only.
boolean
If true, indicates a dry run intent. The API call is still executed but this flag is logged for reference.
boolean
Target enabled state (true to enable, false to disable). If not provided, the default enable behavior is used.
string
Optional custom MCP server URL to configure. If provided, it may be sent in the request body if the endpoint accepts it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_AUDIT_LOGSearch 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

string
required
Identifier for the audit log entry to retrieve. Can be a timestamp, user ID, or action type to search for.
string
Organization slug to scope the audit log search (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_EXTENSION_BY_NAMETool 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

string
required
The name of the extension to retrieve (e.g., ‘postgres’, ‘auth0’, ‘stripe’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_EXTENSION_VERSION_BY_NAME_AND_VERSIONTool 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

string
required
The semantic version of the extension (e.g., ‘0.6.1’)
string
required
The name of the extension (e.g., ‘postgres’, ‘mongodb’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_FEDERATED_SCHEMARetrieves 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

string
Branch name to retrieve the federated schema for (defaults to ‘main’ if not provided)
string
Slug identifier of the federated graph (e.g., ‘my-graph’). If not provided, returns the schema from the first available graph.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_INVITATIONRetrieve 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

string
required
The unique identifier of the invitation to retrieve. Uses CompositeID format (e.g., ‘01KFQJ7YT4PSP01A09ACVTR899’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_NOTIFICATIONS_INBOX_MESSAGESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_SCHEMA_CHECKRetrieve 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

string
required
The unique ID of the schema check to retrieve. Obtain this from list_schema_checks action.
string
required
The slug of the graph within the account (e.g., ‘my-graph’)
string
required
The slug of the Grafbase account/organization (e.g., ‘my-org’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_GET_SUBGRAPH_SCHEMARetrieve 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

string
required
The unique name of the subgraph to retrieve the schema for. Use GRAFBASE_LIST_SUBGRAPHS to discover available subgraph names first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_API_KEYSList all API keys (access tokens) for the authenticated Grafbase user. Uses the Grafbase Management API to retrieve access tokens with pagination support.

Input Parameters

integer
Number of API keys to return from the end of the list (backward pagination). Max 100.
string
Cursor for forward pagination. Return items after this cursor.
integer
Number of API keys to return from the beginning of the list (forward pagination). Max 100.
string
Cursor for backward pagination. Return items before this cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_AUDIT_LOGSList 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

string
Pagination cursor to fetch logs after this point
integer
Maximum number of audit log entries to return (default: 50)
string
Organization slug to filter audit logs (optional, returns logs from all accessible organizations if not specified)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_EXTENSIONSList 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_MCP_SERVERSCheck 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

boolean
If True, attempts to verify MCP endpoint accessibility. If False, returns configuration guidance without making network requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_SCHEMA_CHECKSList 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

integer
Number of schema checks to return from the end (max 100). Use with ‘before’ for backward pagination.
string
Cursor for forward pagination. Pass the ‘endCursor’ from a previous response.
integer
Number of schema checks to return (max 100). Use with ‘after’ for pagination.
string
Cursor for backward pagination. Pass the ‘startCursor’ from a previous response.
string
Filter schema checks by branch name (e.g., ‘main’, ‘staging’)
string
required
The slug of the graph within the account (e.g., ‘my-graph’)
string
required
The slug of the Grafbase account/organization (e.g., ‘my-org’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_SCHEMASTool 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

string
Branch name to filter schemas/subgraphs (defaults to showing all branches if not provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_LIST_SUBGRAPHSList 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

string
Branch name to filter subgraphs (e.g., ‘main’, ‘dev’). If not provided, returns subgraphs from all branches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_MARK_NOTIFICATIONS_AS_READTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GRAFBASE_REMOVE_GRAPH_OWNERTool 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

string
required
The unique identifier of the graph to remove the owner from. This is the graph ID in Grafbase format (e.g., 01KFQJ7YT4PSP01A09ACVTR899).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not