@composio/client 0.1.0-alpha.7 → 0.1.0-alpha.71

package/resources/mcp/mcp.d.mts

@@ -1,71 +1,199 @@
 import { APIResource } from "../../core/resource.mjs";
-import * as CommandAPI from "./command.mjs";
-import { Command, CommandGenerateParams, CommandGenerateResponse } from "./command.mjs";
+import * as CustomAPI from "./custom.mjs";
+import { Custom, CustomCreateParams, CustomCreateResponse } from "./custom.mjs";
+import * as GenerateAPI from "./generate.mjs";
+import { Generate, GenerateURLParams, GenerateURLResponse } from "./generate.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * MCP server management
+ */
 export declare class Mcp extends APIResource {
-    command: CommandAPI.Command;
+    custom: CustomAPI.Custom;
+    generate: GenerateAPI.Generate;
+    /**
+     * Creates a new Model Control Protocol (MCP) server instance for the authenticated
+     * project. An MCP server provides a connection point for AI assistants to access
+     * your applications and services. The server is configured with specific
+     * authentication and tool permissions that determine what actions the connected
+     * assistants can perform.
+     *
+     * @example
+     * ```ts
+     * const mcp = await client.mcp.create({
+     *   auth_config_ids: ['ac_1a2b3c4d5e6f'],
+     *   name: 'GitHub Integration Server',
+     * });
+     * ```
+     */
     create(body: McpCreateParams, options?: RequestOptions): APIPromise<McpCreateResponse>;
+    /**
+     * Retrieves detailed configuration information for a specific Model Control
+     * Protocol (MCP) server. The returned data includes connection details, associated
+     * applications, enabled tools, and authentication configuration.
+     *
+     * @example
+     * ```ts
+     * const mcp = await client.mcp.retrieve(
+     *   '550e8400-e29b-41d4-a716-446655440000',
+     * );
+     * ```
+     */
     retrieve(id: string, options?: RequestOptions): APIPromise<McpRetrieveResponse>;
+    /**
+     * Updates the configuration of an existing Model Control Protocol (MCP) server.
+     * You can modify the server name, associated applications, and enabled tools. Only
+     * the fields included in the request will be updated.
+     *
+     * @example
+     * ```ts
+     * const mcp = await client.mcp.update(
+     *   '550e8400-e29b-41d4-a716-446655440000',
+     *   { name: 'Updated GitHub Integration Server' },
+     * );
+     * ```
+     */
     update(id: string, body?: McpUpdateParams | null | undefined, options?: RequestOptions): APIPromise<McpUpdateResponse>;
+    /**
+     * Retrieves a paginated list of MCP servers associated with the authenticated
+     * project. Results can be filtered by name, toolkit, or authentication
+     * configuration ID. MCP servers are used to provide Model Control Protocol
+     * integration points for connecting AI assistants to your applications and
+     * services.
+     *
+     * @example
+     * ```ts
+     * const mcps = await client.mcp.list();
+     * ```
+     */
     list(query?: McpListParams | null | undefined, options?: RequestOptions): APIPromise<McpListResponse>;
+    /**
+     * Performs a soft delete on a Model Control Protocol (MCP) server, making it
+     * unavailable for future use. This operation is reversible in the database but
+     * cannot be undone through the API. Any applications or services connected to this
+     * server will lose access after deletion.
+     *
+     * @example
+     * ```ts
+     * const mcp = await client.mcp.delete(
+     *   '550e8400-e29b-41d4-a716-446655440000',
+     * );
+     * ```
+     */
     delete(id: string, options?: RequestOptions): APIPromise<McpDeleteResponse>;
-    retrieveApp(appKey: string, options?: RequestOptions): APIPromise<McpRetrieveAppResponse>;
-    validate(uuid: string, params: McpValidateParams, options?: RequestOptions): APIPromise<McpValidateResponse>;
+    /**
+     * Retrieves a paginated list of Model Control Protocol (MCP) servers that are
+     * configured for a specific application or toolkit. This endpoint allows you to
+     * find all MCP server instances that have access to a particular application, such
+     * as GitHub, Slack, or Jira.
+     *
+     * @example
+     * ```ts
+     * const response = await client.mcp.retrieveApp('github');
+     * ```
+     */
+    retrieveApp(appKey: string, query?: McpRetrieveAppParams | null | undefined, options?: RequestOptions): APIPromise<McpRetrieveAppResponse>;
 }
+/**
+ * MCP server configuration and connection details
+ */
 export interface McpCreateResponse {
     /**
-     * The ID of the MCP server
+     * UUID of the MCP server instance
      */
     id: string;
     /**
-     * The app IDs associated with the server
+     * Array of tool slugs that this MCP server is allowed to use
+     */
+    allowed_tools: Array<string>;
+    /**
+     * ID references to the auth configurations used by this server
+     */
+    auth_config_ids: Array<string>;
+    /**
+     * @deprecated Set of command line instructions for connecting various clients to
+     * this MCP server
+     */
+    commands: McpCreateResponse.Commands;
+    /**
+     * Date and time when this server was initially created
      */
-    apps: Array<string>;
+    created_at: string;
     /**
-     * The member ID who created the server
+     * Whether the MCP server is managed by Composio
      */
-    member_id: string;
+    managed_auth_via_composio: boolean;
     /**
-     * The name of the MCP server
+     * @deprecated [DEPRECATED] Please use the URL with user_id or connected_account_id
+     * query param
+     */
+    mcp_url: string;
+    /**
+     * User-defined descriptive name for this MCP server
      */
     name: string;
     /**
-     * Signed URL for the MCP server
+     * Total count of active user instances connected to this server
      */
-    signed_url: string;
+    server_instance_count: number;
     /**
-     * Last update timestamp of the MCP server
+     * Object mapping each toolkit slug to its icon/logo URL for display purposes
      */
-    updated_at: string;
+    toolkit_icons: {
+        [key: string]: string;
+    };
     /**
-     * The URL of the MCP server
+     * Array of toolkit slugs that this MCP server is allowed to use
      */
-    url: string;
+    toolkits: Array<string>;
     /**
-     * Auth configuration
+     * Date and time when this server configuration was last modified
      */
-    auth_configs?: Record<string, unknown>;
+    updated_at: string;
+}
+export declare namespace McpCreateResponse {
     /**
-     * Connected account IDs
+     * @deprecated Set of command line instructions for connecting various clients to
+     * this MCP server
      */
-    connected_account_ids?: Array<string>;
+    interface Commands {
+        /**
+         * @deprecated Command line instruction for Claude client setup
+         */
+        claude: string;
+        /**
+         * @deprecated Command line instruction for Cursor client setup
+         */
+        cursor: string;
+        /**
+         * @deprecated Command line instruction for Windsurf client setup
+         */
+        windsurf: string;
+    }
 }
+/**
+ * MCP server configuration and connection details
+ */
 export interface McpRetrieveResponse {
     /**
-     * The ID of the MCP server
+     * UUID of the MCP server instance
      */
     id: string;
     /**
-     * The app IDs associated with the server
+     * Array of tool slugs that this MCP server is allowed to use
      */
-    apps: Array<string>;
+    allowed_tools: Array<string>;
     /**
-     * Client ID associated with the MCP server
+     * ID references to the auth configurations used by this server
      */
-    client_id: string;
+    auth_config_ids: Array<string>;
     /**
-     * Creation timestamp of the MCP server
+     * @deprecated Set of command line instructions for connecting various clients to
+     * this MCP server
+     */
+    commands: McpRetrieveResponse.Commands;
+    /**
+     * Date and time when this server was initially created
      */
     created_at: string;
     /**
@@ -73,57 +201,80 @@ export interface McpRetrieveResponse {
      */
     deleted: boolean;
     /**
-     * The member ID who created the server
-     */
-    member_id: string;
-    /**
-     * The name of the MCP server
+     * Whether the MCP server is managed by Composio
      */
-    name: string;
+    managed_auth_via_composio: boolean;
     /**
-     * Last update timestamp of the MCP server
+     * @deprecated [DEPRECATED] Please use the URL with user_id or connected_account_id
+     * query param
      */
-    updated_at: string;
+    mcp_url: string;
     /**
-     * The URL of the MCP server
+     * User-defined descriptive name for this MCP server
      */
-    url: string;
+    name: string;
     /**
-     * Actions available for the MCP server
+     * Total count of active user instances connected to this server
      */
-    actions?: Record<string, unknown>;
+    server_instance_count: number;
     /**
-     * Auth configuration
+     * Object mapping each toolkit slug to its icon/logo URL for display purposes
      */
-    auth_configs?: Record<string, unknown>;
+    toolkit_icons: {
+        [key: string]: string;
+    };
     /**
-     * Connected account IDs
+     * Array of toolkit slugs that this MCP server is allowed to use
      */
-    connected_account_ids?: Array<string>;
+    toolkits: Array<string>;
     /**
-     * Whether custom auth headers are enabled
+     * Date and time when this server configuration was last modified
      */
-    custom_auth_headers?: boolean;
+    updated_at: string;
+}
+export declare namespace McpRetrieveResponse {
     /**
-     * Entity IDs associated with the server
+     * @deprecated Set of command line instructions for connecting various clients to
+     * this MCP server
      */
-    entity_ids?: Array<string>;
+    interface Commands {
+        /**
+         * @deprecated Command line instruction for Claude client setup
+         */
+        claude: string;
+        /**
+         * @deprecated Command line instruction for Cursor client setup
+         */
+        cursor: string;
+        /**
+         * @deprecated Command line instruction for Windsurf client setup
+         */
+        windsurf: string;
+    }
 }
+/**
+ * MCP server configuration and connection details
+ */
 export interface McpUpdateResponse {
     /**
-     * The ID of the MCP server
+     * UUID of the MCP server instance
      */
     id: string;
     /**
-     * The app IDs associated with the server
+     * Array of tool slugs that this MCP server is allowed to use
+     */
+    allowed_tools: Array<string>;
+    /**
+     * ID references to the auth configurations used by this server
      */
-    apps: Array<string>;
+    auth_config_ids: Array<string>;
     /**
-     * Client ID associated with the MCP server
+     * @deprecated Set of command line instructions for connecting various clients to
+     * this MCP server
      */
-    client_id: string;
+    commands: McpUpdateResponse.Commands;
     /**
-     * Creation timestamp of the MCP server
+     * Date and time when this server was initially created
      */
     created_at: string;
     /**
@@ -131,248 +282,372 @@ export interface McpUpdateResponse {
      */
     deleted: boolean;
     /**
-     * The member ID who created the server
+     * Whether the MCP server is managed by Composio
+     */
+    managed_auth_via_composio: boolean;
+    /**
+     * @deprecated [DEPRECATED] Please use the URL with user_id or connected_account_id
+     * query param
      */
-    member_id: string;
+    mcp_url: string;
     /**
-     * The name of the MCP server
+     * User-defined descriptive name for this MCP server
      */
     name: string;
     /**
-     * Last update timestamp of the MCP server
+     * Total count of active user instances connected to this server
      */
-    updated_at: string;
+    server_instance_count: number;
     /**
-     * The URL of the MCP server
+     * Object mapping each toolkit slug to its icon/logo URL for display purposes
      */
-    url: string;
+    toolkit_icons: {
+        [key: string]: string;
+    };
     /**
-     * Actions available for the MCP server
+     * Array of toolkit slugs that this MCP server is allowed to use
      */
-    actions?: Record<string, unknown>;
+    toolkits: Array<string>;
     /**
-     * Auth configuration
+     * Date and time when this server configuration was last modified
      */
-    auth_configs?: Record<string, unknown>;
+    updated_at: string;
+}
+export declare namespace McpUpdateResponse {
+    /**
+     * @deprecated Set of command line instructions for connecting various clients to
+     * this MCP server
+     */
+    interface Commands {
+        /**
+         * @deprecated Command line instruction for Claude client setup
+         */
+        claude: string;
+        /**
+         * @deprecated Command line instruction for Cursor client setup
+         */
+        cursor: string;
+        /**
+         * @deprecated Command line instruction for Windsurf client setup
+         */
+        windsurf: string;
+    }
+}
+/**
+ * Paginated response containing MCP servers
+ */
+export interface McpListResponse {
     /**
-     * Connected account IDs
+     * Current page number being returned
      */
-    connected_account_ids?: Array<string>;
+    current_page: number;
     /**
-     * Whether custom auth headers are enabled
+     * Array of MCP server configurations
      */
-    custom_auth_headers?: boolean;
+    items: Array<McpListResponse.Item>;
     /**
-     * Entity IDs associated with the server
+     * Total number of pages in the paginated response
      */
-    entity_ids?: Array<string>;
+    total_pages: number;
 }
-export type McpListResponse = Array<McpListResponse.McpListResponseItem>;
 export declare namespace McpListResponse {
-    interface McpListResponseItem {
+    /**
+     * MCP server configuration and connection details
+     */
+    interface Item {
         /**
-         * The ID of the MCP server
+         * UUID of the MCP server instance
          */
         id: string;
         /**
-         * The app IDs associated with the server
+         * Array of tool slugs that this MCP server is allowed to use
+         */
+        allowed_tools: Array<string>;
+        /**
+         * ID references to the auth configurations used by this server
+         */
+        auth_config_ids: Array<string>;
+        /**
+         * @deprecated Set of command line instructions for connecting various clients to
+         * this MCP server
+         */
+        commands: Item.Commands;
+        /**
+         * Date and time when this server was initially created
          */
-        apps: Array<string>;
+        created_at: string;
         /**
-         * The member ID who created the server
+         * Whether the MCP server is managed by Composio
          */
-        member_id: string;
+        managed_auth_via_composio: boolean;
         /**
-         * The name of the MCP server
+         * @deprecated [DEPRECATED] Please use the URL with user_id or connected_account_id
+         * query param
+         */
+        mcp_url: string;
+        /**
+         * User-defined descriptive name for this MCP server
          */
         name: string;
         /**
-         * Last update timestamp of the MCP server
+         * Total count of active user instances connected to this server
          */
-        updated_at: string;
+        server_instance_count: number;
         /**
-         * The URL of the MCP server
+         * Object mapping each toolkit slug to its icon/logo URL for display purposes
          */
-        url: string;
+        toolkit_icons: {
+            [key: string]: string;
+        };
         /**
-         * Auth configuration
+         * Array of toolkit slugs that this MCP server is allowed to use
          */
-        auth_configs?: Record<string, unknown>;
+        toolkits: Array<string>;
         /**
-         * Connected account IDs
+         * Date and time when this server configuration was last modified
          */
-        connected_account_ids?: Array<string>;
+        updated_at: string;
+    }
+    namespace Item {
+        /**
+         * @deprecated Set of command line instructions for connecting various clients to
+         * this MCP server
+         */
+        interface Commands {
+            /**
+             * @deprecated Command line instruction for Claude client setup
+             */
+            claude: string;
+            /**
+             * @deprecated Command line instruction for Cursor client setup
+             */
+            cursor: string;
+            /**
+             * @deprecated Command line instruction for Windsurf client setup
+             */
+            windsurf: string;
+        }
     }
 }
+/**
+ * Response indicating the success of the delete operation
+ */
 export interface McpDeleteResponse {
     /**
-     * Operation success status
+     * Unique identifier of the MCP server to retrieve, update, or delete
+     */
+    id: string;
+    /**
+     * Indicates whether the MCP server was successfully deleted
      */
-    success: boolean;
+    deleted: boolean;
 }
+/**
+ * Paginated response containing MCP servers
+ */
 export interface McpRetrieveAppResponse {
+    /**
+     * Current page number being returned
+     */
+    current_page: number;
+    /**
+     * Array of MCP server configurations
+     */
     items: Array<McpRetrieveAppResponse.Item>;
+    /**
+     * Total number of pages in the paginated response
+     */
+    total_pages: number;
 }
 export declare namespace McpRetrieveAppResponse {
+    /**
+     * MCP server configuration and connection details
+     */
     interface Item {
         /**
-         * The ID of the MCP server
+         * UUID of the MCP server instance
          */
         id: string;
         /**
-         * The app IDs associated with the server
+         * Array of tool slugs that this MCP server is allowed to use
          */
-        apps: Array<string>;
+        allowed_tools: Array<string>;
         /**
-         * The member ID who created the server
+         * ID references to the auth configurations used by this server
          */
-        member_id: string;
+        auth_config_ids: Array<string>;
         /**
-         * The name of the MCP server
+         * @deprecated Set of command line instructions for connecting various clients to
+         * this MCP server
          */
-        name: string;
+        commands: Item.Commands;
         /**
-         * Last update timestamp of the MCP server
+         * Date and time when this server was initially created
          */
-        updated_at: string;
+        created_at: string;
         /**
-         * The URL of the MCP server
+         * Whether the MCP server is managed by Composio
          */
-        url: string;
+        managed_auth_via_composio: boolean;
         /**
-         * Auth configuration
+         * @deprecated [DEPRECATED] Please use the URL with user_id or connected_account_id
+         * query param
          */
-        auth_configs?: Record<string, unknown>;
+        mcp_url: string;
         /**
-         * Connected account IDs
+         * User-defined descriptive name for this MCP server
          */
-        connected_account_ids?: Array<string>;
-    }
-}
-export interface McpValidateResponse {
-    /**
-     * The ID of the MCP server
-     */
-    id: string;
-    client: McpValidateResponse.Client;
-    /**
-     * The name of the MCP server
-     */
-    name: string;
-    /**
-     * The URL of the MCP server
-     */
-    url: string;
-    userData: McpValidateResponse.UserData;
-}
-export declare namespace McpValidateResponse {
-    interface Client {
+        name: string;
         /**
-         * The client ID
+         * Total count of active user instances connected to this server
          */
-        id: string;
+        server_instance_count: number;
         /**
-         * The organization ID
+         * Object mapping each toolkit slug to its icon/logo URL for display purposes
          */
-        orgId: string;
-    }
-    interface UserData {
+        toolkit_icons: {
+            [key: string]: string;
+        };
         /**
-         * The user ID
+         * Array of toolkit slugs that this MCP server is allowed to use
          */
-        id: string;
+        toolkits: Array<string>;
         /**
-         * The API key
+         * Date and time when this server configuration was last modified
          */
-        apiKey: string;
+        updated_at: string;
+    }
+    namespace Item {
         /**
-         * The user email
+         * @deprecated Set of command line instructions for connecting various clients to
+         * this MCP server
          */
-        email: string;
+        interface Commands {
+            /**
+             * @deprecated Command line instruction for Claude client setup
+             */
+            claude: string;
+            /**
+             * @deprecated Command line instruction for Cursor client setup
+             */
+            cursor: string;
+            /**
+             * @deprecated Command line instruction for Windsurf client setup
+             */
+            windsurf: string;
+        }
     }
 }
 export interface McpCreateParams {
     /**
-     * Name of the MCP server
+     * ID references to existing authentication configurations
+     */
+    auth_config_ids: Array<string>;
+    /**
+     * Human-readable name to identify this MCP server instance (4-30 characters,
+     * alphanumeric, spaces, and hyphens only)
      */
     name: string;
     /**
-     * Actions available for the server
+     * List of tool slugs that should be allowed for this server. If not provided, all
+     * available tools for the authentication configuration will be enabled.
+     */
+    allowed_tools?: Array<string>;
+    /**
+     * Whether the MCP server is managed by Composio
      */
-    actions?: Array<string>;
+    managed_auth_via_composio?: boolean;
     /**
-     * App IDs associated with the server
+     * List of NO_AUTH apps to enable for this MCP server
      */
-    apps?: Array<string>;
+    no_auth_apps?: Array<string>;
+}
+export interface McpUpdateParams {
     /**
-     * Auth configurations
+     * List of action identifiers that should be enabled for this server
      */
-    auth_configs?: Record<string, unknown>;
+    allowed_tools?: Array<string>;
     /**
-     * Connected account IDs
+     * List of auth config IDs to use for this MCP server.
      */
-    connected_account_ids?: Array<string>;
+    auth_config_ids?: Array<string>;
     /**
-     * Whether to use custom auth headers
+     * Whether the MCP server is managed by Composio
      */
-    custom_auth_headers?: boolean;
+    managed_auth_via_composio?: boolean;
     /**
-     * Entity IDs
+     * Human-readable name to identify this MCP server instance (4-30 characters,
+     * alphanumeric, spaces, and hyphens only)
      */
-    entity_ids?: Array<string>;
+    name?: string;
     /**
-     * Time to live for the server
+     * List of toolkit slugs this server should be configured to work with.
      */
-    ttl?: '1d' | '3d' | '1 month' | 'no expiration';
+    toolkits?: Array<string>;
 }
-export interface McpUpdateParams {
+export interface McpListParams {
     /**
-     * Actions available for the server
+     * Comma-separated list of auth config IDs to filter servers by
      */
-    actions?: Array<string>;
+    auth_config_ids?: string;
     /**
-     * App IDs associated with the server
+     * Number of items per page (default: 10)
      */
-    apps?: Array<string>;
+    limit?: number | null;
     /**
-     * Name of the MCP server
+     * Filter MCP servers by name (case-insensitive partial match)
      */
     name?: string;
-}
-export interface McpListParams {
     /**
-     * App IDs to filter by
+     * Field to order results by
      */
-    app_id?: Array<string>;
+    order_by?: 'created_at' | 'updated_at';
     /**
-     * Connected account IDs to filter by
+     * Direction of ordering
      */
-    connected_account_id?: Array<string>;
+    order_direction?: 'asc' | 'desc';
     /**
-     * Cursor for pagination
+     * Page number for pagination (1-based)
      */
-    cursor?: number | null;
+    page_no?: number | null;
     /**
-     * Entity IDs to filter by
+     * Comma-separated list of toolkit slugs to filter servers by
      */
-    entity_id?: Array<string>;
+    toolkits?: string;
+}
+export interface McpRetrieveAppParams {
     /**
-     * Integration ID to filter by
+     * Comma-separated list of auth config IDs to filter servers by
      */
-    integration_id?: string;
+    auth_config_ids?: string;
     /**
-     * Limit for pagination
+     * Number of items per page (default: 10)
      */
     limit?: number | null;
-}
-export interface McpValidateParams {
     /**
-     * Admin token
+     * Filter MCP servers by name (case-insensitive partial match)
+     */
+    name?: string;
+    /**
+     * Field to order results by
+     */
+    order_by?: 'created_at' | 'updated_at';
+    /**
+     * Direction of ordering
+     */
+    order_direction?: 'asc' | 'desc';
+    /**
+     * Page number for pagination (1-based)
+     */
+    page_no?: number | null;
+    /**
+     * Comma-separated list of toolkit slugs to filter servers by
      */
-    'x-admin-token': string;
+    toolkits?: string;
 }
 export declare namespace Mcp {
-    export { type McpCreateResponse as McpCreateResponse, type McpRetrieveResponse as McpRetrieveResponse, type McpUpdateResponse as McpUpdateResponse, type McpListResponse as McpListResponse, type McpDeleteResponse as McpDeleteResponse, type McpRetrieveAppResponse as McpRetrieveAppResponse, type McpValidateResponse as McpValidateResponse, type McpCreateParams as McpCreateParams, type McpUpdateParams as McpUpdateParams, type McpListParams as McpListParams, type McpValidateParams as McpValidateParams, };
-    export { Command as Command, type CommandGenerateResponse as CommandGenerateResponse, type CommandGenerateParams as CommandGenerateParams, };
+    export { type McpCreateResponse as McpCreateResponse, type McpRetrieveResponse as McpRetrieveResponse, type McpUpdateResponse as McpUpdateResponse, type McpListResponse as McpListResponse, type McpDeleteResponse as McpDeleteResponse, type McpRetrieveAppResponse as McpRetrieveAppResponse, type McpCreateParams as McpCreateParams, type McpUpdateParams as McpUpdateParams, type McpListParams as McpListParams, type McpRetrieveAppParams as McpRetrieveAppParams, };
+    export { Custom as Custom, type CustomCreateResponse as CustomCreateResponse, type CustomCreateParams as CustomCreateParams, };
+    export { Generate as Generate, type GenerateURLResponse as GenerateURLResponse, type GenerateURLParams as GenerateURLParams, };
 }
 //# sourceMappingURL=mcp.d.mts.map