integrateintegrate

View as Markdown

Convex Integration

Manage Convex projects, deployments, regions, classes, and environment variables

The Convex integration provides access to manage Convex projects, deployments, regions, classes, and environment variables through the Integrate MCP server.

Installation

The Convex integration is included with the SDK:

import { convexIntegration } from "integrate-sdk/server";

Setup

Add Convex to your server configuration. Provide credentials via environment variables or integration config:

import { createMCPServer, convexIntegration } from "integrate-sdk/server";
 
export const { client: serverClient } = createMCPServer({
  apiKey: process.env.INTEGRATE_API_KEY,
  integrations: [
    convexIntegration({
      // See configuration options below
    }),
  ],
});

Client-Side Usage

import { client } from "integrate-sdk";
 
const result = await client.convex.managementTokenDetails({});
 
console.log(result);

Environment Variables

  • CONVEX_API_KEY (when supported by this integration)

Configuration Options

export interface ConvexIntegrationOptions {
  accessToken?: string;

Tools

convex_management_token_details

Management token details

No parameters.

convex_management_list_projects

Management list projects

export type ConvexManagementListProjectsParams = Record<string, unknown>;

convex_management_create_project

Management create project

export type ConvexManagementCreateProjectParams = Record<string, unknown>;

convex_management_get_project

Management get project

export type ConvexManagementGetProjectParams = Record<string, unknown>;

convex_management_delete_project

Management delete project

export type ConvexManagementDeleteProjectParams = Record<string, unknown>;

convex_management_list_deployments

Management list deployments

export type ConvexManagementListDeploymentsParams = Record<string, unknown>;

convex_management_list_team_deployments

Management list team deployments

export type ConvexManagementListTeamDeploymentsParams = Record<string, unknown>;

convex_management_get_deployment

Management get deployment

export type ConvexManagementGetDeploymentParams = Record<string, unknown>;

convex_management_create_deployment

Management create deployment

export type ConvexManagementCreateDeploymentParams = Record<string, unknown>;

convex_management_update_deployment

Management update deployment

export type ConvexManagementUpdateDeploymentParams = Record<string, unknown>;

convex_management_delete_deployment

Management delete deployment

export type ConvexManagementDeleteDeploymentParams = Record<string, unknown>;

convex_management_list_deployment_regions

Management list deployment regions

No parameters.

convex_management_list_deployment_classes

Management list deployment classes

No parameters.

convex_management_list_default_environment_variables

Management list default environment variables

export type ConvexManagementListDefaultEnvironmentVariablesParams = Record<string, unknown>;

convex_management_update_default_environment_variables

Management update default environment variables

export type ConvexManagementUpdateDefaultEnvironmentVariablesParams = Record<string, unknown>;

convex_deployment_list_environment_variables

Deployment list environment variables

export type ConvexDeploymentListEnvironmentVariablesParams = Record<string, unknown>;

convex_deployment_update_environment_variables

Deployment update environment variables

export type ConvexDeploymentUpdateEnvironmentVariablesParams = Record<string, unknown>;

Notes

  • Category: Engineering
  • Authentication mode: API key