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

package/src/resources/mcp/mcp.ts

@@ -0,0 +1,522 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CommandAPI from './command';
+import { Command } from './command';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Mcp extends APIResource {
+  command: CommandAPI.Command = new CommandAPI.Command(this._client);
+
+  /**
+   * 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);
+  }
+
+  /**
+   * 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> {
+    return this._client.patch(path`/api/v3/mcp/${id}`, { body, ...options });
+  }
+
+  /**
+   * 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);
+  }
+
+  /**
+   * 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> {
+    return this._client.get(path`/api/v3/mcp/app/${appKey}`, { query, ...options });
+  }
+
+  /**
+   * 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,
+    params: McpValidateParams,
+    options?: RequestOptions,
+  ): APIPromise<McpValidateResponse> {
+    const { 'x-composio-admin-token': xComposioAdminToken } = params;
+    return this._client.get(path`/api/v3/mcp/validate/${uuid}`, {
+      ...options,
+      headers: buildHeaders([{ 'x-composio-admin-token': xComposioAdminToken }, options?.headers]),
+    });
+  }
+}
+
+/**
+ * MCP server configuration and connection details
+ */
+export interface McpRetrieveResponse {
+  /**
+   * UUID of the MCP server instance
+   */
+  id: string;
+
+  /**
+   * 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
+   */
+  auth_config_id: string;
+
+  /**
+   * 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;
+
+  /**
+   * Whether the MCP server is deleted
+   */
+  deleted: boolean;
+
+  /**
+   * URL endpoint for establishing SSE connection to this MCP server
+   */
+  mcp_url: string;
+
+  /**
+   * User-defined descriptive name for this MCP server
+   */
+  name: string;
+
+  /**
+   * Date and time when this server configuration was last modified
+   */
+  updated_at: string;
+}
+
+export namespace McpRetrieveResponse {
+  /**
+   * Set of command line instructions for connecting various clients to this MCP
+   * server
+   */
+  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;
+  }
+}
+
+/**
+ * MCP server configuration and connection details
+ */
+export interface McpUpdateResponse {
+  /**
+   * UUID of the MCP server instance
+   */
+  id: string;
+
+  /**
+   * 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
+   */
+  auth_config_id: string;
+
+  /**
+   * 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;
+
+  /**
+   * Whether the MCP server is deleted
+   */
+  deleted: boolean;
+
+  /**
+   * URL endpoint for establishing SSE connection to this MCP server
+   */
+  mcp_url: string;
+
+  /**
+   * User-defined descriptive name for this MCP server
+   */
+  name: string;
+
+  /**
+   * Date and time when this server configuration was last modified
+   */
+  updated_at: string;
+}
+
+export namespace McpUpdateResponse {
+  /**
+   * Set of command line instructions for connecting various clients to this MCP
+   * server
+   */
+  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;
+  }
+}
+
+/**
+ * Response indicating the success of the delete operation
+ */
+export interface McpDeleteResponse {
+  /**
+   * 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 {
+    /**
+     * UUID of the MCP server instance
+     */
+    id: string;
+
+    /**
+     * 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
+     */
+    auth_config_id: string;
+
+    /**
+     * 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
+     */
+    created_at: string;
+
+    /**
+     * URL endpoint for establishing SSE connection to this MCP server
+     */
+    mcp_url: string;
+
+    /**
+     * User-defined descriptive name for this MCP server
+     */
+    name: string;
+
+    /**
+     * Date and time when this server configuration was last modified
+     */
+    updated_at: string;
+  }
+
+  export namespace Item {
+    /**
+     * Set of command line instructions for connecting various clients to this MCP
+     * server
+     */
+    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 {
+  /**
+   * Unique identifier of the validated MCP server
+   */
+  id: string;
+
+  /**
+   * Client information for the MCP server
+   */
+  client: McpValidateResponse.Client;
+
+  /**
+   * Human-readable name of the MCP server
+   */
+  name: string;
+
+  /**
+   * 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 {
+    /**
+     * Project identifier that owns this MCP server
+     */
+    id: string;
+
+    /**
+     * Organization identifier that owns the project
+     */
+    orgId: string;
+  }
+
+  /**
+   * User authentication data for the MCP server
+   */
+  export interface UserData {
+    /**
+     * User identifier for API access
+     */
+    id: string;
+
+    /**
+     * API key for authenticating requests to the Composio API
+     */
+    apiKey: string;
+
+    /**
+     * Email address associated with the API key user
+     */
+    email: string;
+  }
+}
+
+export interface McpUpdateParams {
+  /**
+   * List of action identifiers that should be enabled for this server
+   */
+  actions?: Array<string>;
+
+  /**
+   * List of application identifiers this server should be configured to work with
+   */
+  apps?: Array<string>;
+
+  /**
+   * Human-readable name to identify this MCP server instance (4-25 characters,
+   * alphanumeric and hyphens only)
+   */
+  name?: string;
+}
+
+export interface McpRetrieveAppParams {
+  /**
+   * Filter MCP servers by authentication configuration ID
+   */
+  auth_config_id?: string;
+
+  /**
+   * Number of items per page (default: 10)
+   */
+  limit?: number | null;
+
+  /**
+   * 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
+   */
+  toolkit?: string;
+}
+
+export interface McpValidateParams {
+  /**
+   * Administrative access token required for validating MCP servers
+   */
+  'x-composio-admin-token': string;
+}
+
+Mcp.Command = Command;
+
+export declare namespace Mcp {
+  export {
+    type McpRetrieveResponse as McpRetrieveResponse,
+    type McpUpdateResponse as McpUpdateResponse,
+    type McpDeleteResponse as McpDeleteResponse,
+    type McpRetrieveAppResponse as McpRetrieveAppResponse,
+    type McpValidateResponse as McpValidateResponse,
+    type McpUpdateParams as McpUpdateParams,
+    type McpRetrieveAppParams as McpRetrieveAppParams,
+    type McpValidateParams as McpValidateParams,
+  };
+
+  export { Command as Command };
+}

package/src/resources/mcp.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './mcp/index';

package/src/resources/migration.ts

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Migration extends APIResource {
+  /**
+   * Convert a legacy UUID to its corresponding NanoId for migration purposes. This
+   * endpoint facilitates the transition from UUID-based identifiers to the more
+   * compact NanoId format used in the v3 API.
+   */
+  retrieveNanoid(
+    query: MigrationRetrieveNanoidParams,
+    options?: RequestOptions,
+  ): APIPromise<MigrationRetrieveNanoidResponse> {
+    return this._client.get('/api/v3/migration/get-nanoid', { query, ...options });
+  }
+}
+
+export interface MigrationRetrieveNanoidResponse {
+  /**
+   * The NanoId corresponding to the provided UUID. This is the new identifier that
+   * should be used in place of the legacy UUID.
+   */
+  nanoid: string;
+}
+
+export interface MigrationRetrieveNanoidParams {
+  /**
+   * The type of resource that the UUID belongs to
+   */
+  type: 'CONNECTED_ACCOUNT' | 'AUTH_CONFIG' | 'TRIGGER_INSTANCE';
+
+  /**
+   * The legacy UUID that needs to be converted to a NanoId
+   */
+  uuid: string;
+}
+
+export declare namespace Migration {
+  export {
+    type MigrationRetrieveNanoidResponse as MigrationRetrieveNanoidResponse,
+    type MigrationRetrieveNanoidParams as MigrationRetrieveNanoidParams,
+  };
+}

package/src/resources/org/api-key.ts

@@ -5,20 +5,48 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
 export class APIKey extends APIResource {
+  /**
+   * Retrieve the API key for the current organization. This endpoint is restricted
+   * to organization administrators only. The returned API key can be used for
+   * authenticating organization-level API requests.
+   *
+   * @example
+   * ```ts
+   * const apiKey = await client.org.apiKey.retrieve();
+   * ```
+   */
   retrieve(options?: RequestOptions): APIPromise<APIKeyRetrieveResponse> {
     return this._client.get('/api/v3/org/api_key', options);
   }
 
+  /**
+   * Generate a new API key for the organization, invalidating the previous one
+   * (admin only). This operation cannot be undone and will immediately invalidate
+   * the previous API key.
+   *
+   * @example
+   * ```ts
+   * const response = await client.org.apiKey.regenerate();
+   * ```
+   */
   regenerate(options?: RequestOptions): APIPromise<APIKeyRegenerateResponse> {
     return this._client.post('/api/v3/org/api_key/regenerate', options);
   }
 }
 
 export interface APIKeyRetrieveResponse {
+  /**
+   * The API key for the organization that can be used for authentication. Format:
+   * org_xxx
+   */
   org_api_key: string;
 }
 
 export interface APIKeyRegenerateResponse {
+  /**
+   * The newly generated API key for the organization that can be used for
+   * authentication. Format: org_xxx
+   */
   org_api_key: string;
 }