Docs · static mirror — the interactive version loads with JavaScript.

Convex

Source: https://runstack.engineer/docs/toolkits/convex

Projects, deployments, functions, and logs.

Tools (19):

ToolDescription
convexCreateProjectCreate a project on a team, optionally provisioning a dev or prod deployment alongside it. Returns the projectId (and deployment URL/name when requested).
convexListProjectsList all projects for a team by team ID. Use to discover project IDs before deployment operations.
convexGetProjectByIdGet project metadata (name, slug, team, creation time) by numeric project ID.
convexGetProjectBySlugGet a project by its human-readable slug within a team. Accepts a numeric team ID or team slug.
convexDeleteProjectPermanently delete a project and all its deployments and data. Irreversible — confirm with the user first.
convexCreateDeploymentCreate a dev, prod, or custom deployment in a project, with optional class, reference, and region. Returns the deployment name and URL.
convexListDeploymentsList deployments for a project (production, preview, and optionally local), with filters for default status, type, and local inclusion.
convexGetDeploymentGet details for a deployment by name: configuration, region, creation time, and status.
convexUpdateDeploymentUpdate deployment settings (reference, dashboard edit confirmation). Only provided fields are modified.
convexDeleteDeploymentPermanently delete a deployment and all its data and files. Irreversible — confirm with the user first.
convexCreateDeployKeyCreate a deploy key for CLI development or deployment workflows. The key grants admin access — store it securely and confirm with the user first.
convexListDeployKeysList deploy keys for a deployment (names, creators, creation and last-used times). Key values are not returned — create a new key if one is lost.
convexDeleteCustomDomainRemove a custom domain from a deployment. Specify whether it serves the Convex Cloud backend or the Convex Site frontend. Confirm with the user first.
convexGetTokenDetailsGet details for the connected token itself: type (team or project) and the team or project ID it belongs to. No parameters. Use after connecting to identify the token scope.
convexListDeploymentClassesList deployment classes available to a team with availability flags. Use before creating a deployment with an explicit class.
convexListDeploymentRegionsList deployment regions available to a team with availability flags. Use before creating a deployment in a specific region.
convexExecuteQueryBatchRun multiple query functions against a deployment in one batch call. Results come back in request order with per-query status, value, and log lines.
convexGetQueryTimestampGet the latest query timestamp (base64) for a deployment. Use for consistent reads or auditing the deployment state.
convexListLogStreamsList log stream configurations (Datadog, Webhook, Axiom, Sentry) for a deployment, with per-stream status.