> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mcp-use.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Oauth
> OAuth authentication support for MCP clients API Documentation
export const RandomGradientBackground = ({className, color, children, grayscaled = false}) => {
const saturation = useMemo(() => {
if (color) {
const values = color.split("(")[1].split(")")[0].trim().split(/\s+/);
return parseFloat(values[1] || "0");
}
return grayscaled ? 0 : 0.2;
}, [color, grayscaled]);
const lightness = useMemo(() => {
if (color) {
const values = color.split("(")[1].split(")")[0].trim().split(/\s+/);
return parseFloat(values[0] || "0.5");
}
return grayscaled ? 0.3 : 0.4;
}, [color, grayscaled]);
const randomHue = useMemo(() => {
if (color) {
const values = color.split("(")[1].split(")")[0].trim().split(/\s+/);
return parseFloat(values[2] || "0");
}
return Math.floor(Math.random() * 360);
}, [color]);
const randomColor = useMemo(() => {
if (color) {
return color;
}
return `oklch(${Math.min(lightness, 1)} ${saturation} ${randomHue})`;
}, [randomHue, saturation, lightness]);
const lightColor = useMemo(() => {
return `oklch(${Math.min(lightness * 2, 1)} ${saturation} ${randomHue})`;
}, [randomHue, saturation, lightness, color]);
const direction = useMemo(() => {
return Math.floor(Math.random() * 360);
}, [randomHue]);
const brightnessFilter = useMemo(() => {
return "1000%";
}, []);
return ;
};
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](https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/client/auth/oauth.py)
OAuth authentication support for MCP clients.
## ClientRegistrationResponse
class ClientRegistrationResponse
Dynamic Client Registration response.
It represents the response from an OAuth server
when you dinamically register a new OAuth client.
```python theme={null}
from mcp_use.client.auth.oauth import ClientRegistrationResponse
```
**Attributes**
>
MCP client instance
MCP client instance
MCP client instance
MCP client instance
List of items
List of items
List of items
MCP client instance
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**
> Parameter value
**Signature**
```python wrap theme={null}
def __init__(data: Any):
```
## FileTokenStorage
class FileTokenStorage
File-based token storage.
It's responsible for:
* Saving OAuth tokens to disk after auth
* Loading saved tokens when the app restarts
* Deleting tokens when they're revoked
* Organizing tokens by server URL
```python theme={null}
from mcp_use.client.auth.oauth import FileTokenStorage
```
### `method` **init**
Initialize token storage.
**Parameters**
> Base directory for token storage. Defaults to \~/.mcp\_use/tokens
**Signature**
```python wrap theme={null}
def __init__(base_dir: pathlib.Path | None = None):
```
### `method` delete\_tokens
Delete tokens for a server.
**Parameters**
> Server name or configuration
**Signature**
```python wrap theme={null}
def delete_tokens(server_url: str):
```
### `method` load\_tokens
Load tokens from file.
**Parameters**
> Server name or configuration
**Returns**
>
**Signature**
```python wrap theme={null}
def load_tokens(server_url: str):
```
### `method` save\_tokens
Save tokens to file.
**Parameters**
> Server name or configuration
> Dictionary of key-value pairs
**Signature**
```python wrap theme={null}
def save_tokens(server_url: str, tokens: dict[str, Any]):
```
## OAuth
class OAuth
OAuth authentication handler for MCP clients.
This is the main class that handles all the authentication
It has several features:
* Discovers OAuth server capabilities automatically
* Registers client dynamically when possible
* Manages token storage and refresh automaticlly
```python theme={null}
from mcp_use.client.auth.oauth import OAuth
```
### `method` **init**
Initialize OAuth handler.
**Parameters**
> The MCP server URL
> Token storage implementation. Defaults to FileTokenStorage
> OAuth scopes to request
> OAuth client ID. If not provided, will attempt dynamic registration
> OAuth client secret (for confidential clients)
> Port for local callback server, if empty, 8080 is used
> OAuth client provider to prevent metadata discovery
> Field used to authenticate with CIMD
**Signature**
```python wrap theme={null}
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**
>
**Signature**
```python wrap theme={null}
def authenticate():
```
### `method` initialize
Initialize OAuth and return bearer auth if tokens exist.
**Parameters**
> MCP client instance
**Returns**
>
**Signature**
```python wrap theme={null}
def initialize(client: httpx.AsyncClient):
```
### `method` refresh\_token
Refresh the access token if possible.
**Returns**
>
**Signature**
```python wrap theme={null}
def refresh_token():
```
## OAuthClientProvider
class OAuthClientProvider
OAuth client provider configuration for a specific server.
This contains all the information needed to authenticate with an OAuth server
without needing to discover metadata or register clients dynamically.
```python theme={null}
from mcp_use.client.auth.oauth import OAuthClientProvider
```
**Attributes**
>
String value
Name identifier
Dictionary of key-value pairs
### `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**
> Parameter value
**Signature**
```python wrap theme={null}
def __init__(data: Any):
```
### `property` oauth\_metadata
Get OAuth metadata as ServerOAuthMetadata instance.
**Returns**
>
**Signature**
```python wrap theme={null}
def oauth_metadata():
```
## ProtectedResourceMetadata
class ProtectedResourceMetadata
PRM (Protected Resource Metadata) can have metadata
describing their configuration. It could contain information
about the OAuth metadata.
```python theme={null}
from mcp_use.client.auth.oauth import ProtectedResourceMetadata
```
**Attributes**
>
String value
Server name or configuration
List of items
### `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**
> Parameter value
**Signature**
```python wrap theme={null}
def __init__(data: Any):
```
## ServerOAuthMetadata
class ServerOAuthMetadata
OAuth metadata from MCP server with flexible field support.
It is essentially a configuration that tells MCP client:
* Where to send users for authorization
* Where to exchange the codes for tokens
* Which OAuth features are supported
* Where to register new users with DCR
```python theme={null}
from mcp_use.client.auth.oauth import ServerOAuthMetadata
```
**Attributes**
>
Parameter value
Parameter value
Parameter value
Parameter value
Parameter value
Parameter value
Parameter value
Parameter value
List of items
List of items
List of items
List of items
List of items
List of items
List of items
MCP client instance
### `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**
> Parameter value
**Signature**
```python wrap theme={null}
def __init__(data: Any):
```
## TokenData
class TokenData
OAuth token data.
This is the information received after
successfull authentication
```python theme={null}
from mcp_use.client.auth.oauth import TokenData
```
**Attributes**
>
String value
String value
Parameter value
String value
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**
> Parameter value
**Signature**
```python wrap theme={null}
def __init__(data: Any):
```