Skip to main content
Defined in: client/browser-oauth.ts:19

​
Extends

​
Properties

​
clientId?

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

​
Inherited from

OAuthOptions.clientId

​
clientMetadataUrl?

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.

​
Inherited from

OAuthOptions.clientMetadataUrl

​
clientName?

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

​
Inherited from

OAuthOptions.clientName

​
clientSecret?

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

​
Inherited from

OAuthOptions.clientSecret

​
mode?

Defined in: client/browser-oauth.ts:32 ‘popup’ (default) opens the authorization URL in a popup window and listens for a postMessage from the callback page. ‘redirect’ navigates the whole tab; resume with BrowserOAuth.resumeFromRedirect on return.

​
popupFeatures?

Defined in: client/browser-oauth.ts:34 window.open features string for popup mode.

​
redirectUri

Defined in: client/browser-oauth.ts:26 Redirect URI registered with the provider. Must serve a page that calls handleOAuthCallback (popup mode) or is your app route that reads the returned ?code= (redirect mode).

​
scopes?

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

​
Inherited from

OAuthOptions.scopes

​
store?

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

​
Inherited from

OAuthOptions.store