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
62 lines
1.6 KiB
Plaintext
62 lines
1.6 KiB
Plaintext
---
|
|
title: "Routes"
|
|
description: "Route handlers for the MCP server API Documentation"
|
|
icon: "code"
|
|
github: "https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/utils/routes.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/utils/routes.py' target='_blank' rel='noopener noreferrer'>https://github.com/mcp-use/mcp-use/blob/main/libraries/python/mcp_use/server/utils/routes.py</a>
|
|
</Callout>
|
|
|
|
Route handlers for the MCP server.
|
|
|
|
|
|
## docs_ui
|
|
<Card type="info">
|
|
### `function` docs_ui
|
|
|
|
Serve the docs UI.
|
|
|
|
```python
|
|
from mcp_use.server.utils.routes import docs_ui
|
|
```
|
|
|
|
**Parameters**
|
|
><ParamField body="request" type="starlette.requests.Request" required="True" > Parameter value </ParamField>
|
|
|
|
**Returns**
|
|
><ResponseField name="returns" type="starlette.responses.HTMLResponse" />
|
|
|
|
**Signature**
|
|
```python wrap
|
|
def docs_ui(request: starlette.requests.Request):
|
|
```
|
|
|
|
</Card>
|
|
|
|
|
|
## openmcp_json
|
|
<Card type="info">
|
|
### `function` openmcp_json
|
|
|
|
Serve the OpenMCP JSON configuration.
|
|
|
|
```python
|
|
from mcp_use.server.utils.routes import openmcp_json
|
|
```
|
|
|
|
**Parameters**
|
|
><ParamField body="request" type="starlette.requests.Request" required="True" > Parameter value </ParamField>
|
|
><ParamField body="server" required="True" > Server name or configuration </ParamField>
|
|
|
|
**Signature**
|
|
```python wrap
|
|
def openmcp_json(request: starlette.requests.Request, server):
|
|
```
|
|
|
|
</Card>
|