Convex
convexBackend-as-a-Service platform with real-time database, serverless functions, and built-in authentication
Acciones disponibles (19)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create deploy keyCONVEX_CREATE_DEPLOY_KEYAcciónTool to create a deploy key for use with the Convex CLI. Use when you need to generate credentials for CLI-based development or deployment workflows. The generated key provides administrative access to the specified deployment.
CONVEX_CREATE_DEPLOY_KEYAcciónTool to create a deploy key for use with the Convex CLI. Use when you need to generate credentials for CLI-based development or deployment workflows. The generated key provides administrative access to the specified deployment.
Parámetros de entrada
namestringObligatorioName for the deploy key. This is a human-readable identifier that helps you remember what this key is used for.
deployment_namestringObligatorioThe name of the deployment for which to create the deploy key. This identifies the specific Convex deployment.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create DeploymentCONVEX_CREATE_DEPLOYMENTAcciónTool to create a new deployment for a Convex project. Use when you need to create a development, production, or custom deployment. Specify the deployment type and optional configuration like class, reference, and region.
CONVEX_CREATE_DEPLOYMENTAcciónTool to create a new deployment for a Convex project. Use when you need to create a development, production, or custom deployment. Specify the deployment type and optional configuration like class, reference, and region.
Parámetros de entrada
typestringObligatorioenumThe type of deployment to create: 'dev' for development, 'prod' for production, or 'custom' for custom deployment
devprodcustomclassstringThe class to use for this deployment. If not provided, the default deployment class for your team will be used
regionstringThe region where the deployment should be created
referencestringAn identifier that uniquely identifies this deployment within the project. By providing a reference, you can create multiple dev and prod deployments in the project. If not provided, a reference will be automatically generated
project_idintegerObligatorioThe ID of the project to create the deployment in
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create ProjectCONVEX_CREATE_PROJECTAcciónTool to create a new project on a Convex team, optionally provisioning a dev or prod deployment. Use when you need to initialize a new Convex project in a team.
CONVEX_CREATE_PROJECTAcciónTool to create a new project on a Convex team, optionally provisioning a dev or prod deployment. Use when you need to initialize a new Convex project in a team.
Parámetros de entrada
team_idintegerObligatorioTeam ID where the project will be created
projectNamestringObligatorioName of the project to create
deploymentTypestringType of deployment to create (e.g., 'dev' or 'prod'). If not provided, no deployment will be created initially.
deploymentClassstringClass to use for the deployment. If not provided, the default deployment class for your team will be used.
deploymentRegionstringRegion where the deployment should be hosted. If not provided, uses the default region for your team.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Custom DomainCONVEX_DELETE_CUSTOM_DOMAINAcciónTool to remove a custom domain from a Convex deployment. Use when you need to delete a previously configured custom domain.
CONVEX_DELETE_CUSTOM_DOMAINAcciónTool to remove a custom domain from a Convex deployment. Use when you need to delete a previously configured custom domain.
Parámetros de entrada
domainstringObligatorioThe custom domain name to delete (e.g., 'test-domain.example.com')
deployment_namestringObligatorioThe name of the deployment to delete the custom domain from (e.g., 'quiet-llama-744')
requestDestinationstringObligatorioenumThe destination type for this custom domain: 'convexCloud' for Convex Cloud deployments or 'convexSite' for Convex Site deployments
convexCloudconvexSite
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DeploymentCONVEX_DELETE_DEPLOYMENTAcciónTool to delete a Convex deployment. Use when you need to permanently remove a deployment and all its data. WARNING: This action will delete all data and files in the deployment and cannot be undone.
CONVEX_DELETE_DEPLOYMENTAcciónTool to delete a Convex deployment. Use when you need to permanently remove a deployment and all its data. WARNING: This action will delete all data and files in the deployment and cannot be undone.
Parámetros de entrada
deployment_namestringObligatorioThe name of the deployment to delete. This will permanently delete all data and files in the deployment.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete projectCONVEX_DELETE_PROJECTAcciónDeletes a Convex project and all its deployments permanently. Use when you need to permanently remove a project and all associated data. This operation cannot be undone.
CONVEX_DELETE_PROJECTAcciónDeletes a Convex project and all its deployments permanently. Use when you need to permanently remove a project and all associated data. This operation cannot be undone.
Parámetros de entrada
project_idintegerObligatorioThe unique identifier of the project to delete. This will delete the project and all its deployments permanently.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Execute Query BatchCONVEX_EXECUTE_QUERY_BATCHAcciónTool to execute multiple Convex query functions in a single batch request. Use when you need to fetch data from multiple queries efficiently in one API call.
CONVEX_EXECUTE_QUERY_BATCHAcciónTool to execute multiple Convex query functions in a single batch request. Use when you need to fetch data from multiple queries efficiently in one API call.
Parámetros de entrada
queriesobject[]ObligatorioArray of query items to execute in the batch. Each item specifies a query function path and its arguments.
deployment_urlstringFull deployment URL (e.g., 'https://quiet-llama-744.convex.cloud'). If not provided, uses the base_url from auth metadata.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Deployment DetailsCONVEX_GET_DEPLOYMENTAcciónTool to retrieve details about a Convex cloud deployment. Use when you need to get information about a specific deployment including its configuration, region, creation time, and status.
CONVEX_GET_DEPLOYMENTAcciónTool to retrieve details about a Convex cloud deployment. Use when you need to get information about a specific deployment including its configuration, region, creation time, and status.
Parámetros de entrada
deployment_namestringObligatorioThe name of the deployment to retrieve (e.g., 'quiet-llama-744')
Parámetros de salida
dataanyObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Project by IDCONVEX_GET_PROJECT_BY_IDAcciónTool to retrieve detailed information about a specific Convex project by its ID. Use when you need to fetch project metadata including name, slug, team association, and creation time.
CONVEX_GET_PROJECT_BY_IDAcciónTool to retrieve detailed information about a specific Convex project by its ID. Use when you need to fetch project metadata including name, slug, team association, and creation time.
Parámetros de entrada
project_idintegerObligatorioThe unique identifier of the project to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Project by SlugCONVEX_GET_PROJECT_BY_SLUGAcciónTool to retrieve a Convex project by its slug within a team. Use when you need to fetch project details using human-readable identifiers instead of numeric IDs.
CONVEX_GET_PROJECT_BY_SLUGAcciónTool to retrieve a Convex project by its slug within a team. Use when you need to fetch project details using human-readable identifiers instead of numeric IDs.
Parámetros de entrada
project_slugstringObligatorioProject slug (unique identifier within the team) to retrieve
team_id_or_slugstringObligatorioTeam ID (numeric) or team slug (string identifier) to scope the project lookup
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Query TimestampCONVEX_GET_QUERY_TIMESTAMPAcciónTool to get the latest timestamp for queries from Convex deployment. Use when you need to retrieve the current query timestamp from the Convex API.
CONVEX_GET_QUERY_TIMESTAMPAcciónTool to get the latest timestamp for queries from Convex deployment. Use when you need to retrieve the current query timestamp from the Convex API.
Parámetros de entrada
deployment_namestringObligatorioThe name of the deployment to get the query timestamp for (e.g., 'quiet-llama-744')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get token detailsCONVEX_GET_TOKEN_DETAILSAcciónTool to retrieve token details for the authenticated token. Returns the team ID for team tokens or project ID for project tokens. Especially useful after receiving a token from an OAuth flow to identify which team or project it belongs to.
CONVEX_GET_TOKEN_DETAILSAcciónTool to retrieve token details for the authenticated token. Returns the team ID for team tokens or project ID for project tokens. Especially useful after receiving a token from an OAuth flow to identify which team or project it belongs to.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Deploy KeysCONVEX_LIST_DEPLOY_KEYSAcciónTool to list all deploy keys for a specified Convex deployment. Use when you need to view all authentication tokens that can be used to deploy to this deployment.
CONVEX_LIST_DEPLOY_KEYSAcciónTool to list all deploy keys for a specified Convex deployment. Use when you need to view all authentication tokens that can be used to deploy to this deployment.
Parámetros de entrada
deployment_namestringObligatorioThe name of the deployment to list deploy keys for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List deployment classesCONVEX_LIST_DEPLOYMENT_CLASSESAcciónTool to list available deployment classes for a Convex team. Use when you need to check which deployment classes are available for a specific team.
CONVEX_LIST_DEPLOYMENT_CLASSESAcciónTool to list available deployment classes for a Convex team. Use when you need to check which deployment classes are available for a specific team.
Parámetros de entrada
team_idstringObligatorioThe unique identifier of the team to list deployment classes for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List deployment regionsCONVEX_LIST_DEPLOYMENT_REGIONSAcciónTool to list available deployment regions for a Convex team. Use when you need to check which regions are available for deploying a team's backend.
CONVEX_LIST_DEPLOYMENT_REGIONSAcciónTool to list available deployment regions for a Convex team. Use when you need to check which regions are available for deploying a team's backend.
Parámetros de entrada
team_idstringObligatorioThe unique identifier for the team whose available deployment regions you want to list.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List DeploymentsCONVEX_LIST_DEPLOYMENTSAcciónTool to list all deployments for a Convex project. Use when you need to see all deployments (production, preview, or local) for a specific project.
CONVEX_LIST_DEPLOYMENTSAcciónTool to list all deployments for a Convex project. Use when you need to see all deployments (production, preview, or local) for a specific project.
Parámetros de entrada
isDefaultbooleanIf true, only include default deployments. If false, only include non-default deployments.
project_idintegerObligatorioProject ID to list deployments for.
includeLocalbooleanIf true, include local deployments in the response (filtered to only show local deployments created by the requesting team member).
deploymentTypestringOnly include deployments of the given deployment type.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List Log StreamsCONVEX_LIST_LOG_STREAMSAcciónTool to list all existing log stream configurations in a deployment. Use when you need to view configured log streaming destinations like Datadog, Webhook, Axiom, or Sentry.
CONVEX_LIST_LOG_STREAMSAcciónTool to list all existing log stream configurations in a deployment. Use when you need to view configured log streaming destinations like Datadog, Webhook, Axiom, or Sentry.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List ProjectsCONVEX_LIST_PROJECTSAcciónTool to list all projects for a specific Convex team. Use when you need to retrieve all projects associated with a team by team ID.
CONVEX_LIST_PROJECTSAcciónTool to list all projects for a specific Convex team. Use when you need to retrieve all projects associated with a team by team ID.
Parámetros de entrada
team_idintegerObligatorioThe unique identifier of the team to list projects for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update DeploymentCONVEX_UPDATE_DEPLOYMENTAcciónTool to update properties of an existing Convex deployment. Use when you need to modify deployment settings such as dashboard edit confirmation or deployment reference. Only the fields provided in the request are modified.
CONVEX_UPDATE_DEPLOYMENTAcciónTool to update properties of an existing Convex deployment. Use when you need to modify deployment settings such as dashboard edit confirmation or deployment reference. Only the fields provided in the request are modified.
Parámetros de entrada
referencestringThe reference of the deployment. Must be unique across deployment references in the project. Requirements: 3-100 characters, only lowercase letters, numbers, '-' and '/', cannot follow deployment name format [a-z]+-[a-z]+-[0-9]+, cannot start with 'local-', cannot be reserved keywords: 'prod', 'dev', 'cloud', 'local', 'default', 'name', 'new', 'existing', 'deployment', 'preview'. Set to null to clear the reference.
deployment_namestringObligatorioThe name of the deployment to update (e.g., 'quiet-llama-744'). This is the unique identifier for the deployment.
dashboard_edit_confirmationbooleanControls whether the dashboard requires confirmation before allowing edits during a browser session. Set to null to reset to default behavior (true for prod deployments, false for dev and preview). Set to true or false to explicitly override the setting.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not