// 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 { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams, } from '../../../../../core/pagination'; import { RequestOptions } from '../../../../../internal/request-options'; import { path } from '../../../../../internal/utils/path'; export class BaseServers extends APIResource { static override readonly _key: readonly ['zeroTrust', 'access', 'aiControls', 'mcp', 'servers'] = Object.freeze(['zeroTrust', 'access', 'aiControls', 'mcp', 'servers'] as const); /** * Creates a new MCP portal for managing AI tool access through Cloudflare Access. * * @example * ```ts * const server = * await client.zeroTrust.access.aiControls.mcp.servers.create( * { * account_id: 'a86a8f5c339544d7bdc89926de14fb8c', * id: 'my-mcp-server', * auth_type: 'unauthenticated', * hostname: 'https://example.com/mcp', * name: 'My MCP Server', * }, * ); * ``` */ create(params: ServerCreateParams, options?: RequestOptions): APIPromise { const { account_id, ...body } = params; return ( this._client.post(path`/accounts/${account_id}/access/ai-controls/mcp/servers`, { body, ...options, }) as APIPromise<{ result: ServerCreateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Updates an MCP portal configuration. * * @example * ```ts * const server = * await client.zeroTrust.access.aiControls.mcp.servers.update( * 'my-mcp-server', * { account_id: 'a86a8f5c339544d7bdc89926de14fb8c' }, * ); * ``` */ update(id: string, params: ServerUpdateParams, options?: RequestOptions): APIPromise { const { account_id, ...body } = params; return ( this._client.put(path`/accounts/${account_id}/access/ai-controls/mcp/servers/${id}`, { body, ...options, }) as APIPromise<{ result: ServerUpdateResponse }> )._thenUnwrap((obj) => obj.result); } /** * Lists all MCP portals configured for the account. * * @example * ```ts * // Automatically fetches more pages as needed. * for await (const serverListResponse of client.zeroTrust.access.aiControls.mcp.servers.list( * { account_id: 'a86a8f5c339544d7bdc89926de14fb8c' }, * )) { * // ... * } * ``` */ list( params: ServerListParams, options?: RequestOptions, ): PagePromise { const { account_id, ...query } = params; return this._client.getAPIList( path`/accounts/${account_id}/access/ai-controls/mcp/servers`, V4PagePaginationArray, { query, ...options }, ); } /** * Deletes an MCP portal from the account. * * @example * ```ts * const server = * await client.zeroTrust.access.aiControls.mcp.servers.delete( * 'my-mcp-server', * { account_id: 'a86a8f5c339544d7bdc89926de14fb8c' }, * ); * ``` */ delete(id: string, params: ServerDeleteParams, options?: RequestOptions): APIPromise { const { account_id } = params; return ( this._client.delete( path`/accounts/${account_id}/access/ai-controls/mcp/servers/${id}`, options, ) as APIPromise<{ result: ServerDeleteResponse }> )._thenUnwrap((obj) => obj.result); } /** * Retrieves gateway configuration for MCP portals. * * @example * ```ts * const response = * await client.zeroTrust.access.aiControls.mcp.servers.read( * 'my-mcp-server', * { account_id: 'a86a8f5c339544d7bdc89926de14fb8c' }, * ); * ``` */ read(id: string, params: ServerReadParams, options?: RequestOptions): APIPromise { const { account_id } = params; return ( this._client.get( path`/accounts/${account_id}/access/ai-controls/mcp/servers/${id}`, options, ) as APIPromise<{ result: ServerReadResponse }> )._thenUnwrap((obj) => obj.result); } /** * Syncs an MCP server's capabilities and returns the updated server state, * including any connection errors. * * @example * ```ts * const response = * await client.zeroTrust.access.aiControls.mcp.servers.sync( * 'my-mcp-portal', * { account_id: 'a86a8f5c339544d7bdc89926de14fb8c' }, * ); * ``` */ sync(id: string, params: ServerSyncParams, options?: RequestOptions): APIPromise { const { account_id } = params; return ( this._client.post( path`/accounts/${account_id}/access/ai-controls/mcp/servers/${id}/sync`, options, ) as APIPromise<{ result: ServerSyncResponse }> )._thenUnwrap((obj) => obj.result); } } export class Servers extends BaseServers {} export type ServerListResponsesV4PagePaginationArray = V4PagePaginationArray; export interface ServerCreateResponse { /** * server id */ id: string; auth_type: 'oauth' | 'bearer' | 'unauthenticated'; hostname: string; name: string; prompts: Array<{ [key: string]: unknown }>; tools: Array<{ [key: string]: unknown }>; created_at?: string; created_by?: string; description?: string | null; error?: string; error_details?: ServerCreateResponse.ErrorDetails; /** * When true, the gateway worker uses the shared Cloudflare-owned OAuth callback * endpoint as the redirect_uri for upstream on-behalf OAuth, instead of the * customer portal hostname. Defaults to false (off); opt in per server by setting * true. Effective behavior is gated by the gateway worker's per-env rollout mode * KV key. */ is_shared_oauth_callback_enabled?: boolean; last_successful_sync?: string; last_synced?: string; modified_at?: string; modified_by?: string; /** * Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway */ secure_web_gateway?: boolean; status?: string; updated_prompts?: Array; updated_tools?: Array; } export namespace ServerCreateResponse { export interface ErrorDetails { /** * Underlying error message */ cause?: string; /** * True = MCP server returned an error. False = couldn't reach the server */ is_upstream?: boolean; /** * MCP protocol error code */ mcp_code?: number; /** * Whether the error is transient and worth retrying */ retryable?: boolean; /** * HTTP status code from the server */ status_code?: number; } export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerUpdateResponse { /** * server id */ id: string; auth_type: 'oauth' | 'bearer' | 'unauthenticated'; hostname: string; name: string; prompts: Array<{ [key: string]: unknown }>; tools: Array<{ [key: string]: unknown }>; created_at?: string; created_by?: string; description?: string | null; error?: string; error_details?: ServerUpdateResponse.ErrorDetails; /** * When true, the gateway worker uses the shared Cloudflare-owned OAuth callback * endpoint as the redirect_uri for upstream on-behalf OAuth, instead of the * customer portal hostname. Defaults to false (off); opt in per server by setting * true. Effective behavior is gated by the gateway worker's per-env rollout mode * KV key. */ is_shared_oauth_callback_enabled?: boolean; last_successful_sync?: string; last_synced?: string; modified_at?: string; modified_by?: string; /** * Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway */ secure_web_gateway?: boolean; status?: string; updated_prompts?: Array; updated_tools?: Array; } export namespace ServerUpdateResponse { export interface ErrorDetails { /** * Underlying error message */ cause?: string; /** * True = MCP server returned an error. False = couldn't reach the server */ is_upstream?: boolean; /** * MCP protocol error code */ mcp_code?: number; /** * Whether the error is transient and worth retrying */ retryable?: boolean; /** * HTTP status code from the server */ status_code?: number; } export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerListResponse { /** * server id */ id: string; auth_type: 'oauth' | 'bearer' | 'unauthenticated'; hostname: string; name: string; prompts: Array<{ [key: string]: unknown }>; tools: Array<{ [key: string]: unknown }>; created_at?: string; created_by?: string; description?: string | null; error?: string; error_details?: ServerListResponse.ErrorDetails; /** * When true, the gateway worker uses the shared Cloudflare-owned OAuth callback * endpoint as the redirect_uri for upstream on-behalf OAuth, instead of the * customer portal hostname. Defaults to false (off); opt in per server by setting * true. Effective behavior is gated by the gateway worker's per-env rollout mode * KV key. */ is_shared_oauth_callback_enabled?: boolean; last_successful_sync?: string; last_synced?: string; modified_at?: string; modified_by?: string; /** * Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway */ secure_web_gateway?: boolean; status?: string; updated_prompts?: Array; updated_tools?: Array; } export namespace ServerListResponse { export interface ErrorDetails { /** * Underlying error message */ cause?: string; /** * True = MCP server returned an error. False = couldn't reach the server */ is_upstream?: boolean; /** * MCP protocol error code */ mcp_code?: number; /** * Whether the error is transient and worth retrying */ retryable?: boolean; /** * HTTP status code from the server */ status_code?: number; } export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerDeleteResponse { /** * server id */ id: string; auth_type: 'oauth' | 'bearer' | 'unauthenticated'; hostname: string; name: string; prompts: Array<{ [key: string]: unknown }>; tools: Array<{ [key: string]: unknown }>; created_at?: string; created_by?: string; description?: string | null; error?: string; error_details?: ServerDeleteResponse.ErrorDetails; /** * When true, the gateway worker uses the shared Cloudflare-owned OAuth callback * endpoint as the redirect_uri for upstream on-behalf OAuth, instead of the * customer portal hostname. Defaults to false (off); opt in per server by setting * true. Effective behavior is gated by the gateway worker's per-env rollout mode * KV key. */ is_shared_oauth_callback_enabled?: boolean; last_successful_sync?: string; last_synced?: string; modified_at?: string; modified_by?: string; /** * Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway */ secure_web_gateway?: boolean; status?: string; updated_prompts?: Array; updated_tools?: Array; } export namespace ServerDeleteResponse { export interface ErrorDetails { /** * Underlying error message */ cause?: string; /** * True = MCP server returned an error. False = couldn't reach the server */ is_upstream?: boolean; /** * MCP protocol error code */ mcp_code?: number; /** * Whether the error is transient and worth retrying */ retryable?: boolean; /** * HTTP status code from the server */ status_code?: number; } export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerReadResponse { /** * server id */ id: string; auth_type: 'oauth' | 'bearer' | 'unauthenticated'; hostname: string; name: string; prompts: Array<{ [key: string]: unknown }>; tools: Array<{ [key: string]: unknown }>; created_at?: string; created_by?: string; description?: string | null; error?: string; error_details?: ServerReadResponse.ErrorDetails; /** * When true, the gateway worker uses the shared Cloudflare-owned OAuth callback * endpoint as the redirect_uri for upstream on-behalf OAuth, instead of the * customer portal hostname. Defaults to false (off); opt in per server by setting * true. Effective behavior is gated by the gateway worker's per-env rollout mode * KV key. */ is_shared_oauth_callback_enabled?: boolean; last_successful_sync?: string; last_synced?: string; modified_at?: string; modified_by?: string; /** * Route outbound traffic to this MCP server through Zero Trust Secure Web Gateway */ secure_web_gateway?: boolean; status?: string; updated_prompts?: Array; updated_tools?: Array; } export namespace ServerReadResponse { export interface ErrorDetails { /** * Underlying error message */ cause?: string; /** * True = MCP server returned an error. False = couldn't reach the server */ is_upstream?: boolean; /** * MCP protocol error code */ mcp_code?: number; /** * Whether the error is transient and worth retrying */ retryable?: boolean; /** * HTTP status code from the server */ status_code?: number; } export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerSyncResponse { error?: string; error_details?: ServerSyncResponse.ErrorDetails; status?: string; } export namespace ServerSyncResponse { export interface ErrorDetails { /** * Underlying error message */ cause?: string; /** * True = MCP server returned an error. False = couldn't reach the server */ is_upstream?: boolean; /** * MCP protocol error code */ mcp_code?: number; /** * Whether the error is transient and worth retrying */ retryable?: boolean; /** * HTTP status code from the server */ status_code?: number; } } export interface ServerCreateParams { /** * Path param */ account_id: string; /** * Body param: server id */ id: string; /** * Body param */ auth_type: 'oauth' | 'bearer' | 'unauthenticated'; /** * Body param */ hostname: string; /** * Body param */ name: string; /** * Body param */ auth_credentials?: string; /** * Body param */ description?: string | null; /** * Body param: When true, the gateway worker uses the shared Cloudflare-owned OAuth * callback endpoint as the redirect_uri for upstream on-behalf OAuth, instead of * the customer portal hostname. Defaults to false (off); opt in per server by * setting true. Effective behavior is gated by the gateway worker's per-env * rollout mode KV key. */ is_shared_oauth_callback_enabled?: boolean; /** * Body param: Route outbound traffic to this MCP server through Zero Trust Secure * Web Gateway */ secure_web_gateway?: boolean; /** * Body param */ updated_prompts?: Array; /** * Body param */ updated_tools?: Array; } export namespace ServerCreateParams { export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerUpdateParams { /** * Path param */ account_id: string; /** * Body param */ auth_credentials?: string; /** * Body param */ description?: string | null; /** * Body param: When true, the gateway worker uses the shared Cloudflare-owned OAuth * callback endpoint as the redirect_uri for upstream on-behalf OAuth, instead of * the customer portal hostname. Defaults to false (off); opt in per server by * setting true. Effective behavior is gated by the gateway worker's per-env * rollout mode KV key. */ is_shared_oauth_callback_enabled?: boolean; /** * Body param */ name?: string; /** * Body param: Route outbound traffic to this MCP server through Zero Trust Secure * Web Gateway */ secure_web_gateway?: boolean; /** * Body param */ updated_prompts?: Array; /** * Body param */ updated_tools?: Array; } export namespace ServerUpdateParams { export interface UpdatedPrompt { name: string; alias?: string; description?: string; enabled?: boolean; } export interface UpdatedTool { name: string; alias?: string; description?: string; enabled?: boolean; } } export interface ServerListParams extends V4PagePaginationArrayParams { /** * Path param */ account_id: string; /** * Query param: Search by id, name */ search?: string; } export interface ServerDeleteParams { account_id: string; } export interface ServerReadParams { account_id: string; } export interface ServerSyncParams { account_id: string; } export declare namespace Servers { export { type ServerCreateResponse as ServerCreateResponse, type ServerUpdateResponse as ServerUpdateResponse, type ServerListResponse as ServerListResponse, type ServerDeleteResponse as ServerDeleteResponse, type ServerReadResponse as ServerReadResponse, type ServerSyncResponse as ServerSyncResponse, type ServerListResponsesV4PagePaginationArray as ServerListResponsesV4PagePaginationArray, type ServerCreateParams as ServerCreateParams, type ServerUpdateParams as ServerUpdateParams, type ServerListParams as ServerListParams, type ServerDeleteParams as ServerDeleteParams, type ServerReadParams as ServerReadParams, type ServerSyncParams as ServerSyncParams, }; }