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
74 lines
2.3 KiB
Plaintext
74 lines
2.3 KiB
Plaintext
---
|
|
title: "Bearer"
|
|
description: "Bearer token authentication provider for mcp-use server API Documentation"
|
|
icon: "code"
|
|
github: "https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/auth/bearer.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/bearer.py' target='_blank' rel='noopener noreferrer'>https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/auth/bearer.py</a>
|
|
</Callout>
|
|
|
|
Bearer token authentication provider for mcp-use server.
|
|
|
|
## BearerAuthProvider
|
|
|
|
<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> BearerAuthProvider</div>
|
|
|
|
Base class for bearer token authentication.
|
|
|
|
Implement this class to validate bearer tokens from the Authorization header.
|
|
Only requires implementing `verify_token()` - no OAuth complexity.
|
|
|
|
Example:
|
|
```python
|
|
from mcp_use.server import MCPServer
|
|
from mcp_use.server.auth import BearerAuthProvider, AccessToken
|
|
|
|
class MyAuthProvider(BearerAuthProvider):
|
|
async def verify_token(self, token: str) -> AccessToken | None:
|
|
user = await my_auth_service.validate(token)
|
|
if not user:
|
|
return None
|
|
return AccessToken(
|
|
token=token,
|
|
claims=\{"email": user.email, "sub": user.id\},
|
|
)
|
|
|
|
server = MCPServer(name="my-server", auth=MyAuthProvider())
|
|
```
|
|
|
|
</div>
|
|
</RandomGradientBackground>
|
|
```python
|
|
from mcp_use.server.auth.bearer import BearerAuthProvider
|
|
```
|
|
|
|
<Card type="info">
|
|
### `method` verify_token
|
|
|
|
Verify a bearer token and return user information.
|
|
|
|
|
|
|
|
**Parameters**
|
|
><ParamField body="token" type="str" required="True" > The Bearer token from the Authorization header </ParamField>
|
|
|
|
**Returns**
|
|
><ResponseField name="returns" type="AccessToken | None" >AccessToken with user claims if valid, None if invalid/expired</ResponseField>
|
|
|
|
**Signature**
|
|
```python wrap
|
|
def verify_token(token: str):
|
|
```
|
|
|
|
</Card>
|
|
|
|
</div>
|