@composio/client 0.1.0-alpha.10 → 0.1.0-alpha.12

package/resources/mcp/mcp.d.mts

@@ -1,92 +1,174 @@
 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 { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Mcp extends APIResource {
-    command: CommandAPI.Command;
-    /**
-     * Create a new MCP server
+    custom: CustomAPI.Custom;
+    /**
+     * 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({
+     *   name: 'GitHub Integration Server',
+     *   auth_config_id: 'auth_cfg_abc123def456',
+     * });
+     * ```
      */
     create(body: McpCreateParams, options?: RequestOptions): APIPromise<McpCreateResponse>;
     /**
-     * Get MCP server details by ID
+     * 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>;
     /**
-     * Update MCP server configuration
+     * 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>;
     /**
-     * List MCP servers with optional filters
+     * 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>;
     /**
-     * Delete an MCP server
+     * 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>;
     /**
-     * List MCP servers for a specific app
-     */
-    retrieveApp(appKey: string, options?: RequestOptions): APIPromise<McpRetrieveAppResponse>;
-    /**
-     * Validate MCP server and retrieve connection details
-     */
-    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
      */
-    apps: Array<string>;
+    allowed_tools: Array<string>;
     /**
-     * The member ID who created the server
+     * ID reference to the auth configuration used by this server
      */
-    member_id: string;
+    auth_config_id: string;
     /**
-     * The name of the MCP server
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
      */
-    name: string;
+    commands: McpCreateResponse.Commands;
     /**
-     * Signed URL for the MCP server
+     * Date and time when this server was initially created
      */
-    signed_url: string;
+    created_at: string;
     /**
-     * Last update timestamp of the MCP server
+     * URL endpoint for establishing SSE connection to this MCP server
      */
-    updated_at: string;
+    mcp_url: string;
     /**
-     * The URL of the MCP server
+     * User-defined descriptive name for this MCP server
      */
-    url: string;
+    name: 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
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
      */
-    connected_account_ids?: Array<string>;
+    interface Commands {
+        /**
+         * Command line instruction for Claude client setup
+         */
+        claude: string;
+        /**
+         * Command line instruction for Cursor client setup
+         */
+        cursor: string;
+        /**
+         * 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
+     */
+    allowed_tools: Array<string>;
+    /**
+     * ID reference to the auth configuration used by this server
      */
-    apps: Array<string>;
+    auth_config_id: string;
     /**
-     * Client ID associated with the MCP server
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
      */
-    client_id: string;
+    commands: McpRetrieveResponse.Commands;
     /**
-     * Creation timestamp of the MCP server
+     * Date and time when this server was initially created
      */
     created_at: string;
     /**
@@ -94,57 +176,61 @@ export interface McpRetrieveResponse {
      */
     deleted: boolean;
     /**
-     * The member ID who created the server
+     * URL endpoint for establishing SSE connection to this MCP server
      */
-    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
+     * Date and time when this server configuration was last modified
      */
     updated_at: string;
+}
+export declare namespace McpRetrieveResponse {
     /**
-     * The URL of the MCP server
-     */
-    url: string;
-    /**
-     * Actions available for the MCP server
-     */
-    actions?: Record<string, unknown>;
-    /**
-     * Auth configuration
-     */
-    auth_configs?: Record<string, unknown>;
-    /**
-     * Connected account IDs
-     */
-    connected_account_ids?: Array<string>;
-    /**
-     * Whether custom auth headers are enabled
-     */
-    custom_auth_headers?: boolean;
-    /**
-     * Entity IDs associated with the server
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
      */
-    entity_ids?: Array<string>;
+    interface Commands {
+        /**
+         * Command line instruction for Claude client setup
+         */
+        claude: string;
+        /**
+         * Command line instruction for Cursor client setup
+         */
+        cursor: string;
+        /**
+         * 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 reference to the auth configuration used by this server
      */
-    apps: Array<string>;
+    auth_config_id: string;
     /**
-     * Client ID associated with the MCP server
+     * 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;
     /**
@@ -152,263 +238,282 @@ export interface McpUpdateResponse {
      */
     deleted: boolean;
     /**
-     * The member ID who created the server
+     * URL endpoint for establishing SSE connection to this MCP server
      */
-    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
+     * Date and time when this server configuration was last modified
      */
     updated_at: string;
+}
+export declare namespace McpUpdateResponse {
     /**
-     * The URL of the MCP server
-     */
-    url: string;
-    /**
-     * Actions available for the MCP server
-     */
-    actions?: Record<string, unknown>;
-    /**
-     * Auth configuration
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
      */
-    auth_configs?: Record<string, unknown>;
+    interface Commands {
+        /**
+         * Command line instruction for Claude client setup
+         */
+        claude: string;
+        /**
+         * Command line instruction for Cursor client setup
+         */
+        cursor: string;
+        /**
+         * 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: string;
     /**
-     * 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>;
-}
-export interface McpListResponse {
-    items: Array<McpListResponse.Item>;
+    total_pages: string;
 }
 export declare namespace McpListResponse {
+    /**
+     * 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 reference to the auth configuration used by this server
          */
-        member_id: string;
+        auth_config_id: string;
         /**
-         * The name of the MCP server
+         * 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
+         * URL endpoint for establishing SSE connection to this MCP server
          */
-        url: string;
+        mcp_url: string;
         /**
-         * Actions available for the MCP server
+         * User-defined descriptive name for this MCP server
          */
-        actions?: Array<string>;
+        name: string;
         /**
-         * Auth configuration
+         * Date and time when this server configuration was last modified
          */
-        auth_configs?: Record<string, unknown>;
+        updated_at: string;
+    }
+    namespace Item {
         /**
-         * Connected account IDs
+         * Set of command line instructions for connecting various clients to this MCP
+         * server
          */
-        connected_account_ids?: Array<string>;
+        interface Commands {
+            /**
+             * Command line instruction for Claude client setup
+             */
+            claude: string;
+            /**
+             * Command line instruction for Cursor client setup
+             */
+            cursor: string;
+            /**
+             * Command line instruction for Windsurf client setup
+             */
+            windsurf: string;
+        }
     }
 }
+/**
+ * Response indicating the success of the delete operation
+ */
 export interface McpDeleteResponse {
     /**
-     * Operation success status
+     * Indicates whether the MCP server was successfully deleted
      */
     success: boolean;
 }
+/**
+ * Paginated response containing MCP servers
+ */
 export interface McpRetrieveAppResponse {
+    /**
+     * Current page number being returned
+     */
+    current_page: string;
+    /**
+     * Array of MCP server configurations
+     */
     items: Array<McpRetrieveAppResponse.Item>;
+    /**
+     * Total number of pages in the paginated response
+     */
+    total_pages: string;
 }
 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
-         */
-        apps: Array<string>;
-        /**
-         * The member ID who created the server
-         */
-        member_id: string;
-        /**
-         * The name of the MCP server
+         * Array of tool slugs that this MCP server is allowed to use
          */
-        name: string;
-        /**
-         * Last update timestamp of the MCP server
-         */
-        updated_at: string;
+        allowed_tools: Array<string>;
         /**
-         * The URL of the MCP server
+         * ID reference to the auth configuration used by this server
          */
-        url: string;
+        auth_config_id: string;
         /**
-         * Actions available for the MCP server
+         * Set of command line instructions for connecting various clients to this MCP
+         * server
          */
-        actions?: Array<string>;
+        commands: Item.Commands;
         /**
-         * Auth configuration
+         * Date and time when this server was initially created
          */
-        auth_configs?: Record<string, unknown>;
+        created_at: string;
         /**
-         * Connected account IDs
+         * URL endpoint for establishing SSE connection to 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;
-    actions?: Array<string> | null;
-    apps?: Array<string>;
-    connectedAccountIds?: Array<string> | null;
-    customAuthHeaders?: boolean;
-    entityIds?: Array<string> | null;
-}
-export declare namespace McpValidateResponse {
-    interface Client {
+        mcp_url: string;
         /**
-         * The client ID
+         * User-defined descriptive name for this MCP server
          */
-        id: string;
+        name: string;
         /**
-         * The organization ID
+         * Date and time when this server configuration was last modified
          */
-        orgId: string;
+        updated_at: string;
     }
-    interface UserData {
+    namespace Item {
         /**
-         * The user ID
+         * Set of command line instructions for connecting various clients to this MCP
+         * server
          */
-        id: string;
-        /**
-         * The API key
-         */
-        apiKey: string;
-        /**
-         * The user email
-         */
-        email: string;
+        interface Commands {
+            /**
+             * Command line instruction for Claude client setup
+             */
+            claude: string;
+            /**
+             * Command line instruction for Cursor client setup
+             */
+            cursor: string;
+            /**
+             * Command line instruction for Windsurf client setup
+             */
+            windsurf: string;
+        }
     }
 }
 export interface McpCreateParams {
     /**
-     * Name of the MCP server
+     * Human-readable name to identify this MCP server instance (4-25 characters,
+     * alphanumeric and hyphens only)
      */
     name: string;
     /**
-     * Actions available for the server
-     */
-    actions?: Array<string>;
-    /**
-     * App IDs associated with the server
-     */
-    apps?: Array<string>;
-    /**
-     * Auth configurations
+     * List of tool slugs that should be allowed for this server. If not provided, all
+     * available tools for the authentication configuration will be enabled.
      */
-    auth_configs?: Record<string, unknown>;
+    allowed_tools?: Array<string>;
     /**
-     * Connected account IDs
+     * ID reference to an existing authentication configuration
      */
-    connected_account_ids?: Array<string>;
+    auth_config_id?: string;
     /**
-     * Whether to use custom auth headers
-     */
-    custom_auth_headers?: boolean;
-    /**
-     * Entity IDs
-     */
-    entity_ids?: Array<string>;
-    /**
-     * Time to live for the server
+     * Time-to-live duration for this MCP server
      */
     ttl?: '1d' | '3d' | '1 month' | 'no expiration';
 }
 export interface McpUpdateParams {
     /**
-     * Actions available for the server
+     * List of action identifiers that should be enabled for this server
      */
     actions?: Array<string>;
     /**
-     * App IDs associated with the server
+     * List of application identifiers this server should be configured to work with
      */
     apps?: Array<string>;
     /**
-     * Name of the MCP server
+     * Human-readable name to identify this MCP server instance (4-25 characters,
+     * alphanumeric and hyphens only)
      */
     name?: string;
 }
 export interface McpListParams {
     /**
-     * App IDs to filter by
+     * Filter MCP servers by authentication configuration ID
      */
-    app_id?: Array<string> | null;
+    auth_config_id?: string;
     /**
-     * Connected account IDs to filter by
+     * Number of items per page (default: 10)
      */
-    connected_account_id?: Array<string> | null;
+    limit?: number | null;
     /**
-     * Cursor for pagination
+     * Filter MCP servers by name (case-insensitive partial match)
      */
-    cursor?: number | null;
+    name?: string;
     /**
-     * Entity IDs to filter by
+     * Page number for pagination (1-based)
      */
-    entity_id?: Array<string> | null;
+    page_no?: number | null;
     /**
-     * Integration ID to filter by
+     * Filter MCP servers by toolkit slug
      */
-    integration_id?: string;
+    toolkit?: string;
+}
+export interface McpRetrieveAppParams {
     /**
-     * Limit for pagination
+     * Filter MCP servers by authentication configuration ID
+     */
+    auth_config_id?: string;
+    /**
+     * 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;
+    /**
+     * Page number for pagination (1-based)
+     */
+    page_no?: number | null;
+    /**
+     * Filter MCP servers by toolkit slug
      */
-    'x-composio-admin-token': string;
+    toolkit?: 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, };
 }
 //# sourceMappingURL=mcp.d.mts.map