Oauth

View the source code for this module on GitHub: https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/client/auth/oauth.py

OAuth authentication support for MCP clients.

ClientRegistrationResponse

from mcp_use.client.auth.oauth import ClientRegistrationResponse

Attributes

str

required

MCP client instance

str | None

required

MCP client instance

int | None

required

MCP client instance

int | None

required

MCP client instance

list[str] | None

required

List of items

list[str] | None

required

List of items

list[str] | None

required

List of items

str | None

required

MCP client instance

str | None

required

String value

`method` init

Create a new model by parsing and validating input data from keyword arguments.Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.self is explicitly positional-only to allow self as a field name.Parameters

Any
required
Parameter value

Signature

def __init__(data: Any):

FileTokenStorage

from mcp_use.client.auth.oauth import FileTokenStorage

`method` init

Initialize token storage.Parameters

pathlib.Path | None
default:"None"
Base directory for token storage. Defaults to ~/.mcp_use/tokens

Signature

def __init__(base_dir: pathlib.Path | None = None):

`method` delete_tokens

Delete tokens for a server.Parameters

str
required
Server name or configuration

Signature

def delete_tokens(server_url: str):

`method` load_tokens

Load tokens from file.Parameters

str
required
Server name or configuration

Returns

mcp_use.client.auth.oauth.TokenData | None

Signature

def load_tokens(server_url: str):

`method` save_tokens

Save tokens to file.Parameters

str
required
Server name or configuration

dict[str, Any]
required
Dictionary of key-value pairs

Signature

def save_tokens(server_url: str, tokens: dict[str, Any]):

from mcp_use.client.auth.oauth import OAuth

`method` init

Initialize OAuth handler.Parameters

str
required
The MCP server URL

mcp_use.client.auth.oauth.FileTokenStorage | None
default:"None"
Token storage implementation. Defaults to FileTokenStorage

str | None
default:"None"
OAuth scopes to request

str | None
default:"None"
OAuth client ID. If not provided, will attempt dynamic registration

str | None
default:"None"
OAuth client secret (for confidential clients)

int | None
default:"None"
Port for local callback server, if empty, 8080 is used

mcp_use.client.auth.oauth.OAuthClientProvider | None
default:"None"
OAuth client provider to prevent metadata discovery

str | None
default:"None"
Field used to authenticate with CIMD

Signature

def __init__(server_url: str, token_storage: mcp_use.client.auth.oauth.FileTokenStorage | None = None, scope: str | None = None, client_id: str | None = None, client_secret: str | None = None, callback_port: int | None = None, oauth_provider: mcp_use.client.auth.oauth.OAuthClientProvider | None = None, client_metadata_url: str | None = None):

`method` authenticate

Perform OAuth authentication flow.Returns

mcp_use.client.auth.bearer.BearerAuth

Signature

def authenticate():

`method` initialize

Initialize OAuth and return bearer auth if tokens exist.Parameters

httpx.AsyncClient
required
MCP client instance

Returns

mcp_use.client.auth.bearer.BearerAuth | None

Signature

def initialize(client: httpx.AsyncClient):

`method` refresh_token

Refresh the access token if possible.Returns

mcp_use.client.auth.bearer.BearerAuth | None

Signature

def refresh_token():

OAuthClientProvider

from mcp_use.client.auth.oauth import OAuthClientProvider

Attributes

str

required

String value

str

required

Name identifier

mcp_use.client.auth.oauth.ServerOAuthMetadata | dict[str, typing.Any]

required

Dictionary of key-value pairs

`method` init

Any
required
Parameter value

Signature

def __init__(data: Any):

`property` oauth_metadata

Get OAuth metadata as ServerOAuthMetadata instance.Returns

mcp_use.client.auth.oauth.ServerOAuthMetadata

Signature

def oauth_metadata():

ProtectedResourceMetadata

from mcp_use.client.auth.oauth import ProtectedResourceMetadata

Attributes

str

required

String value

list[str]

required

Server name or configuration

list[str] | None

required

List of items

`method` init

Any
required
Parameter value

Signature

def __init__(data: Any):

ServerOAuthMetadata

from mcp_use.client.auth.oauth import ServerOAuthMetadata

Attributes

pydantic.networks.HttpUrl

required

Parameter value

pydantic.networks.HttpUrl

required

Parameter value

pydantic.networks.HttpUrl

required

Parameter value