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

package/src/resources/mcp/mcp.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as CommandAPI from './command';
-import { Command, CommandGenerateParams, CommandGenerateResponse } from './command';
+import { Command } from './command';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -12,21 +12,33 @@ export class Mcp extends APIResource {
   command: CommandAPI.Command = new CommandAPI.Command(this._client);
 
   /**
-   * Create a new MCP server
-   */
-  create(body: McpCreateParams, options?: RequestOptions): APIPromise<McpCreateResponse> {
-    return this._client.post('/api/v3/mcp/create', { body, ...options });
-  }
-
-  /**
-   * 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> {
     return this._client.get(path`/api/v3/mcp/${id}`, options);
   }
 
   /**
-   * 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,
@@ -37,28 +49,54 @@ export class Mcp extends APIResource {
   }
 
   /**
-   * List MCP servers with optional filters
-   */
-  list(query: McpListParams | null | undefined = {}, options?: RequestOptions): APIPromise<McpListResponse> {
-    return this._client.get('/api/v3/mcp/list', { query, ...options });
-  }
-
-  /**
-   * 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> {
     return this._client.delete(path`/api/v3/mcp/${id}`, options);
   }
 
   /**
-   * List MCP servers for a specific app
+   * 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, options?: RequestOptions): APIPromise<McpRetrieveAppResponse> {
-    return this._client.get(path`/api/v3/mcp/app/${appKey}`, options);
+  retrieveApp(
+    appKey: string,
+    query: McpRetrieveAppParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<McpRetrieveAppResponse> {
+    return this._client.get(path`/api/v3/mcp/app/${appKey}`, { query, ...options });
   }
 
   /**
-   * Validate MCP server and retrieve connection details
+   * Admin-only endpoint that validates a Model Control Protocol (MCP) server and
+   * retrieves its complete configuration details, including authentication
+   * information. This endpoint is typically used by the MCP service itself to
+   * authenticate and authorize connection requests from clients.
+   *
+   * @example
+   * ```ts
+   * const response = await client.mcp.validate(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   *   { 'x-composio-admin-token': 'admin_tk_12345abcdef' },
+   * );
+   * ```
    */
   validate(
     uuid: string,
@@ -73,71 +111,33 @@ export class Mcp extends APIResource {
   }
 }
 
-export interface McpCreateResponse {
+/**
+ * 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>;
 
   /**
-   * 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: McpRetrieveResponse.Commands;
 
   /**
-   * Signed URL for the MCP server
-   */
-  signed_url: string;
-
-  /**
-   * Last update timestamp of the MCP server
-   */
-  updated_at: string;
-
-  /**
-   * The URL of the MCP server
-   */
-  url: string;
-
-  /**
-   * Auth configuration
-   */
-  auth_configs?: Record<string, unknown>;
-
-  /**
-   * Connected account IDs
-   */
-  connected_account_ids?: Array<string>;
-}
-
-export interface McpRetrieveResponse {
-  /**
-   * The ID of the MCP server
-   */
-  id: string;
-
-  /**
-   * The app IDs associated with the server
-   */
-  apps: Array<string>;
-
-  /**
-   * Client ID associated with the MCP server
-   */
-  client_id: string;
-
-  /**
-   * Creation timestamp of the MCP server
+   * Date and time when this server was initially created
    */
   created_at: string;
 
@@ -147,69 +147,71 @@ 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 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
+   * Set of command line instructions for connecting various clients to this MCP
+   * server
    */
-  connected_account_ids?: Array<string>;
+  export interface Commands {
+    /**
+     * Command line instruction for Claude client setup
+     */
+    claude: string;
 
-  /**
-   * Whether custom auth headers are enabled
-   */
-  custom_auth_headers?: boolean;
+    /**
+     * Command line instruction for Cursor client setup
+     */
+    cursor: string;
 
-  /**
-   * Entity IDs associated with the server
-   */
-  entity_ids?: Array<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
    */
-  apps: Array<string>;
+  allowed_tools: Array<string>;
 
   /**
-   * Client ID associated with the MCP server
+   * ID reference to the auth configuration used by this server
    */
-  client_id: string;
+  auth_config_id: string;
 
   /**
-   * Creation timestamp of the MCP server
+   * Set of command line instructions for connecting various clients to this MCP
+   * server
+   */
+  commands: McpUpdateResponse.Commands;
+
+  /**
+   * Date and time when this server was initially created
    */
   created_at: string;
 
@@ -219,320 +221,285 @@ 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 namespace McpUpdateResponse {
   /**
-   * 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>;
-}
-
-export interface McpListResponse {
-  items: Array<McpListResponse.Item>;
-}
-
-export namespace McpListResponse {
-  export interface Item {
+  export interface Commands {
     /**
-     * The ID of the MCP server
+     * Command line instruction for Claude client setup
      */
-    id: string;
+    claude: string;
 
     /**
-     * The app IDs associated with the server
+     * Command line instruction for Cursor client setup
      */
-    apps: Array<string>;
+    cursor: string;
 
     /**
-     * The member ID who created the server
+     * Command line instruction for Windsurf client setup
      */
-    member_id: string;
-
-    /**
-     * The name of the MCP server
-     */
-    name: string;
-
-    /**
-     * Last update timestamp of the MCP server
-     */
-    updated_at: string;
-
-    /**
-     * The URL of the MCP server
-     */
-    url: string;
-
-    /**
-     * Actions available for the MCP server
-     */
-    actions?: Array<string>;
-
-    /**
-     * Auth configuration
-     */
-    auth_configs?: Record<string, unknown>;
-
-    /**
-     * Connected account IDs
-     */
-    connected_account_ids?: Array<string>;
+    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 namespace McpRetrieveAppResponse {
+  /**
+   * MCP server configuration and connection details
+   */
   export 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;
+  }
 
+  export namespace Item {
     /**
-     * Connected account IDs
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
      */
-    connected_account_ids?: Array<string>;
+    export 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;
+    }
   }
 }
 
+/**
+ * Complete validation and connection details for an MCP server
+ */
 export interface McpValidateResponse {
   /**
-   * The ID of the MCP server
+   * Unique identifier of the validated MCP server
    */
   id: string;
 
+  /**
+   * Client information for the MCP server
+   */
   client: McpValidateResponse.Client;
 
   /**
-   * The name of the MCP server
+   * Human-readable name of the MCP server
    */
   name: string;
 
   /**
-   * The URL of the MCP server
+   * URL endpoint for connecting to this MCP server
    */
   url: string;
 
+  /**
+   * User authentication data for the MCP server
+   */
   userData: McpValidateResponse.UserData;
 
+  /**
+   * List of action identifiers enabled for this server
+   */
   actions?: Array<string> | null;
 
+  /**
+   * List of application identifiers this server is configured for
+   */
   apps?: Array<string>;
 
+  /**
+   * List of connected account identifiers this server can use for authentication
+   */
   connectedAccountIds?: Array<string> | null;
 
+  /**
+   * Flag indicating if this server uses custom authentication headers
+   */
   customAuthHeaders?: boolean;
 
+  /**
+   * List of entity identifiers this MCP server can interact with
+   */
   entityIds?: Array<string> | null;
 }
 
 export namespace McpValidateResponse {
+  /**
+   * Client information for the MCP server
+   */
   export interface Client {
     /**
-     * The client ID
+     * Project identifier that owns this MCP server
      */
     id: string;
 
     /**
-     * The organization ID
+     * Organization identifier that owns the project
      */
     orgId: string;
   }
 
+  /**
+   * User authentication data for the MCP server
+   */
   export interface UserData {
     /**
-     * The user ID
+     * User identifier for API access
      */
     id: string;
 
     /**
-     * The API key
+     * API key for authenticating requests to the Composio API
      */
     apiKey: string;
 
     /**
-     * The user email
+     * Email address associated with the API key user
      */
     email: string;
   }
 }
 
-export interface McpCreateParams {
-  /**
-   * Name of the MCP server
-   */
-  name: string;
-
-  /**
-   * Actions available for the server
-   */
-  actions?: Array<string>;
-
-  /**
-   * App IDs associated with the server
-   */
-  apps?: Array<string>;
-
-  /**
-   * Auth configurations
-   */
-  auth_configs?: Record<string, unknown>;
-
-  /**
-   * Connected account IDs
-   */
-  connected_account_ids?: Array<string>;
-
-  /**
-   * Whether to use custom auth headers
-   */
-  custom_auth_headers?: boolean;
-
-  /**
-   * Entity IDs
-   */
-  entity_ids?: Array<string>;
-
-  /**
-   * Time to live for the 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
-   */
-  app_id?: Array<string> | null;
-
+export interface McpRetrieveAppParams {
   /**
-   * Connected account IDs to filter by
+   * Filter MCP servers by authentication configuration ID
    */
-  connected_account_id?: Array<string> | null;
+  auth_config_id?: string;
 
   /**
-   * Cursor for pagination
+   * Number of items per page (default: 10)
    */
-  cursor?: number | null;
+  limit?: number | null;
 
   /**
-   * Entity IDs to filter by
+   * Filter MCP servers by name (case-insensitive partial match)
    */
-  entity_id?: Array<string> | null;
+  name?: string;
 
   /**
-   * Integration ID to filter by
+   * Page number for pagination (1-based)
    */
-  integration_id?: string;
+  page_no?: number | null;
 
   /**
-   * Limit for pagination
+   * Filter MCP servers by toolkit slug
    */
-  limit?: number | null;
+  toolkit?: string;
 }
 
 export interface McpValidateParams {
   /**
-   * Admin token
+   * Administrative access token required for validating MCP servers
    */
   'x-composio-admin-token': string;
 }
@@ -541,22 +508,15 @@ Mcp.Command = Command;
 
 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 McpRetrieveAppParams as McpRetrieveAppParams,
     type McpValidateParams as McpValidateParams,
   };
 
-  export {
-    Command as Command,
-    type CommandGenerateResponse as CommandGenerateResponse,
-    type CommandGenerateParams as CommandGenerateParams,
-  };
+  export { Command as Command };
 }