mirror of
https://github.com/mcp-use/mcp-use.git
synced 2026-09-14 18:06:01 +08:00
pietrozullo
ad42b4bb3e
The searchable: false approach on the API Reference tab was inert on visible tabs. Switch to per-page noindex: true frontmatter, which keeps pages in the sidebar but excludes them from search indexing (search engines, internal docs search, and AI context) so generic queries like "CLI" surface curated guides instead of the generated reference. Applied to all 73 existing reference pages and emitted by the generator on every regeneration. Closes MCP-2398
110 lines
3.1 KiB
Plaintext
110 lines
3.1 KiB
Plaintext
---
|
|
title: "Models"
|
|
description: "Authentication models for mcp-use server API Documentation"
|
|
icon: "code"
|
|
github: "https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/auth/models.py"
|
|
noindex: true
|
|
---
|
|
|
|
import {RandomGradientBackground} from "/snippets/gradient.jsx"
|
|
|
|
<Callout type="info" title="Source Code">
|
|
View the source code for this module on GitHub: <a href='https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/auth/models.py' target='_blank' rel='noopener noreferrer'>https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/auth/models.py</a>
|
|
</Callout>
|
|
|
|
Authentication models for mcp-use server.
|
|
|
|
## AccessToken
|
|
|
|
<div>
|
|
<RandomGradientBackground className="rounded-lg p-4 w-full h-full rounded-full">
|
|
<div className="text-black">
|
|
<div className="text-black font-bold text-xl mb-2 mt-8"><code className="!text-black">class</code> AccessToken</div>
|
|
|
|
Validated access token with user claims.
|
|
|
|
Attributes:
|
|
token: The original bearer token
|
|
claims: User information (email, sub, name, etc.)
|
|
scopes: Optional list of permissions/scopes
|
|
|
|
Example:
|
|
```python
|
|
from mcp_use.server.auth import get_access_token
|
|
|
|
@server.tool()
|
|
def whoami() -> str:
|
|
token = get_access_token()
|
|
if token:
|
|
return f"Hello \{token.claims.get('email')\}"
|
|
return "Not authenticated"
|
|
```
|
|
|
|
</div>
|
|
</RandomGradientBackground>
|
|
```python
|
|
from mcp_use.server.auth.models import AccessToken
|
|
```
|
|
|
|
<Card type="info">
|
|
**Attributes**
|
|
>
|
|
<ParamField body="token" type="str" required="True" > String value </ParamField>
|
|
<ParamField body="claims" type="dict[str, Any]" required="True" > Dictionary of key-value pairs </ParamField>
|
|
<ParamField body="scopes" type="list[str]" required="True" > List of items </ParamField>
|
|
|
|
</Card>
|
|
|
|
<Card type="info">
|
|
### `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**
|
|
><ParamField body="data" type="Any" required="True" > Parameter value </ParamField>
|
|
|
|
**Signature**
|
|
```python wrap
|
|
def __init__(data: Any):
|
|
```
|
|
|
|
</Card>
|
|
</div>
|
|
|
|
## AuthenticationError
|
|
|
|
<div>
|
|
<RandomGradientBackground className="rounded-lg p-4 w-full h-full rounded-full">
|
|
<div className="text-black">
|
|
<div className="text-black font-bold text-xl mb-2 mt-8"><code className="!text-black">class</code> AuthenticationError</div>
|
|
|
|
Raised when authentication is required but not provided.
|
|
|
|
</div>
|
|
</RandomGradientBackground>
|
|
```python
|
|
from mcp_use.server.auth.models import AuthenticationError
|
|
```
|
|
|
|
<Card type="info">
|
|
### `method` __init__
|
|
|
|
Initialize self. See help(type(self)) for accurate signature.
|
|
|
|
**Parameters**
|
|
><ParamField body="args" required="True" > Parameter value </ParamField>
|
|
><ParamField body="kwargs" required="True" > Parameter value </ParamField>
|
|
|
|
**Signature**
|
|
```python wrap
|
|
def __init__(args, kwargs):
|
|
```
|
|
|
|
</Card>
|
|
</div>
|