OAuthOptions - FastMCP TS

Properties

callbackPort?

optional callbackPort?: number;

Defined in: client/auth.ts:162 Port for the local OAuth callback server. Default: 8765. The port must be consistent across calls because it is registered as the redirect_uri during Dynamic Client Registration.

clientId?

optional clientId?: string;

Defined in: client/auth.ts:148 Pre-registered client ID. When set, Dynamic Client Registration is skipped.

clientMetadataUrl?

optional clientMetadataUrl?: string;

Defined in: client/auth.ts:177 Client ID Metadata Document URL (SEP-991 / CIMD) — an HTTPS URL, with a non-root path, that serves this client’s metadata document. When the authorization server advertises client_id_metadata_document_supported, the SDK’s auth() orchestrator uses this URL directly as the client_id and skips Dynamic Client Registration entirely. Falls back to normal DCR (or clientId, if set) when the server doesn’t support CIMD. Validated eagerly in the constructor.

clientName?

optional clientName?: string;

Defined in: client/auth.ts:154 Client name used in Dynamic Client Registration. Default: “FastMCP Client”.

clientSecret?

optional clientSecret?: string;

Defined in: client/auth.ts:150 Pre-registered client secret.

onRedirect?

optional onRedirect?: (url) => void | Promise<void>;

Defined in: client/auth.ts:167 Override how the authorization URL is opened. When not provided the system browser is launched. Inject a no-op or mock here for testing.

Parameters

url

URL

Returns

void | Promise<void>

scopes?

optional scopes?: string | string[];

Defined in: client/auth.ts:152 Requested OAuth scopes (space-separated string or array).

store?

optional store?: KeyValueStore;

Defined in: client/auth.ts:156 Persistent key-value store for tokens, client info, and discovery state. Default: in-memory.

​Properties

​callbackPort?

​clientId?

​clientMetadataUrl?

​clientName?

​clientSecret?

​onRedirect?

​Parameters

url

​Returns

​scopes?

​store?