Sanity logo

Sanity

Sanity is a headless CMS platform that provides structured content storage and APIs for modern applications

21 actions Integration catalog
Request access
Connect Sanity once you're in Boring.
01 · WHAT THE AGENT CAN DO

Actions

Every capability is a discrete, logged action the agent calls by name — scoped to what you authorize and recorded in the run trace.

Add Default Role to UsersSANITY_ADD_DEFAULT_ROLE_TO_USERS
Apply organization default role to all users. Use when you need to assign the organization's default role to all existing users in the organization. Requires the resource ID of the organization.
Create Attribute DefinitionSANITY_CREATE_ATTR_DEFINITION
Tool to create a new user attribute definition in Sanity. Use when you need to define a custom attribute (like 'customer-tier' or 'subscription-level') that can be attached to resources. The key must be unique within the resource. The attribute can have a type of 'string', 'number', or 'boolean' and can optionally be a list of values or read-only.
Create Prompt PostSANITY_CREATE_PROMPT_POST
Send a one-shot prompt to the Sanity Content Agent. Stateless one-shot prompt endpoint. No thread management or message persistence. Ideal for simple, single-turn interactions. Use when you need to send a single prompt and receive a response without maintaining conversation context.
Delete User Attribute DefinitionSANITY_DELETE_ATTR_DEFINITION
Delete a user attribute definition. Use when you need to remove a custom attribute definition from an organization or project in Sanity. The attribute definition controls how user attributes are structured and validated for a given resource. Deleting a definition does not delete existing user attribute values, but users will no longer be able to set values for that attribute.
Delete DocumentSANITY_DELETE_DOCUMENT
Delete a document from Sanity by ID or query. This action is irreversible when purge is true — the document cannot be recovered once permanently deleted. Use when you need to remove a specific document by ID or bulk delete documents matching a GROQ query (limited to 10,000 documents per operation). For large deletions, paginate by document ID. Set dry_run to true to test the operation without modifying data.
Delete User AttributesSANITY_DELETE_USER_ATTRIBUTES
Delete custom attributes from a Sanity user within an organization. Use this tool when you need to remove specific custom attributes from a user account. The action deletes the attributes specified in the request and returns the updated attribute list for the user. Example use case: Removing outdated metadata like 'location' or 'year_started' from a user profile.
Get Document by IDSANITY_GET_DOCUMENT
Fetch a single document by its ID from Sanity. Use this action when you need to retrieve a specific document using its unique identifier rather than running a GROQ query. Returns the complete document with all system fields including _id, _type, _rev, _createdAt, and _updatedAt.
Get Invite By TokenSANITY_GET_INVITE_BY_TOKEN
Retrieve an invite by its public token. Use this action when you need to fetch details about an invite using the invite token that was shared with the invitee. Returns invite information including status, role, and inviter details.
Get Organization RoleSANITY_GET_ORG_ROLE
Retrieve a specific organization role by its ID. Use this action when you need to fetch details about an organization role including its permissions, title, description, and whether it applies to users or robots. The role must exist for the specified organization.
Get PermissionSANITY_GET_PERMISSION
Get a permission for a specific resource. Use when you need to retrieve details about a particular permission including its actions, parameters, and scope. The action retrieves permission information based on the resource type, resource ID, and permission name provided in the path parameters.
Get ProjectSANITY_GET_PROJECT
Retrieve full details for a specific Sanity project by its ID. Returns comprehensive project information including display name, organization, studio host, and timestamps. Use this action when you need to fetch complete project details or verify project configuration. Optional parameters allow including member lists and feature flags in the response.
Get RobotsSANITY_GET_ROBOTS
Tool to get robots with access to a resource. Use when you need to retrieve a list of robots (service accounts) that have been granted access to a specific resource along with their assigned roles. This action supports pagination through the next_cursor parameter.
Get RoleSANITY_GET_ROLE
Retrieve a specific role for a given resource type and resource ID. Use this action when you need to fetch details about a role including its permissions, title, description, and whether it applies to users or robots. The role must exist for the specified resource.
List Resource UsersSANITY_GET_USERS
List all users of a resource and their assigned roles. Use when you need to retrieve user information and role assignments for a specific project or organization. Supports pagination via cursor.
List Organization RolesSANITY_LIST_ORG_ROLES
List all roles available for an organization. Use this action to retrieve all available roles that can be assigned to users within a specific Sanity organization. The organization_id is required to identify which organization's roles to list.
List User AttributesSANITY_LIST_USER_ATTRIBUTES
Tool to retrieve user attributes from a Sanity organization. Use when you need to get the attributes (such as roles, permissions, or custom properties) associated with a specific user in a Sanity organization. Supports pagination via the cursor parameter.
Query All ScreeningSANITY_QUERY_ALL_SCREENING
Execute a GROQ query to fetch all screening documents from Sanity. Uses the Sanity HTTP query API endpoint. Default query retrieves all documents of type 'screening'. Supports optional query parameters for dynamic queries.
Query DocumentsSANITY_QUERY_DOCUMENTS
Execute an arbitrary GROQ query against a Sanity dataset. GROQ is Sanity's query language for fetching and transforming content. This is a general-purpose query action distinct from any screening-specific tools. Use this action when you need to query documents from a Sanity dataset using custom GROQ queries. Supports optional parameters, perspective control, and CDN optimization.
Update Organization ACLSANITY_UPDATE_ORG_ACL
Tool to assign a role to a member in a Sanity organization. Use when adding or modifying user roles within an organization.
Update User Attributes ValuesSANITY_UPDATE_USER_ATTRIBUTES_VALUES
Update user attribute values for a resource. Use this action to set or update custom attributes for a user within an organization or project. When setting a value for an attribute key that also exists in SAML, the Sanity value will take precedence and shadow the SAML value.
Validate CredentialSANITY_VALIDATE_CREDENTIAL
Validate Sanity API credentials by fetching the authenticated user's information. Use this action when you need to verify that an API token is valid and has proper authentication. This action returns user information and accessible projects if the token is valid.