mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-24 06:24:18 +02:00
Fix broken code examples in docs (#3869)
* Fix broken code examples in docs - Tag error output blocks as ```text instead of ```python (anthropic, openai integration docs + v2 mirrors) - Quote unquoted URL in Descope config example (+ v2 mirror) - Fix GoogleGenAISamplingHandler → GoogleGenaiSamplingHandler casing in sampling docs - Fix import path: handlers.GoogleGenaiSamplingHandler → handlers.google_genai.GoogleGenaiSamplingHandler in v3-features 🤖 Generated with Claude Code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Fix remaining broken doc examples and add skip tags for false positives - BearerTokenAuth → StaticTokenVerifier in deployment/http.mdx - providers.oauth → server.auth import in authentication.mdx - ListToolsNext → updated list_tools API in v3-features.mdx - OAuthClientProvider → OAuth in v2/storage-backends.mdx - Add test="skip" for upgrade guides, contrib placeholders, f-string backticks 🤖 Generated with Claude Code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Ratchet doc example baselines to zero All 1444 examples now pass syntax and import checks. 🤖 Generated with Claude Code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add pytest-examples dev dep, fix client_id in StaticTokenVerifier example, commit missed openapi fixes - Add pytest-examples to dev dependencies (fixes CI ModuleNotFoundError) - Include required client_id in StaticTokenVerifier token payload - Commit previously unstaged HTTPRoute import fixes in openapi.mdx 🤖 Generated with Claude Code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Update deprecated import paths across docs - fastmcp.server.openapi → fastmcp.server.providers.openapi - fastmcp.server.proxy → fastmcp.server.providers.proxy - fastmcp.server.apps → fastmcp.apps - Tag upgrade guide "Before" examples with test="skip" 🤖 Generated with Claude Code Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Bill Easton
GitHub
parent
d6b55c0b2f
commit
901453902f
30 changed files with 337 additions and 72 deletions
|
|
@ -181,7 +181,7 @@ if __name__ == "__main__":
|
|||
|
||||
If you try to call the authenticated server with the same Anthropic code we wrote earlier, you'll get an error indicating that the server rejected the request because it's not authenticated.
|
||||
|
||||
```python
|
||||
```text
|
||||
Error code: 400 - {
|
||||
"type": "error",
|
||||
"error": {
|
||||
|
|
|
|||
|
|
@ -63,8 +63,8 @@ from fastmcp.server.auth.providers.descope import DescopeProvider
|
|||
# The DescopeProvider automatically discovers Descope endpoints
|
||||
# and configures JWT token validation
|
||||
auth_provider = DescopeProvider(
|
||||
config_url=https://.../.well-known/openid-configuration, # Your MCP Server .well-known URL
|
||||
base_url=SERVER_URL, # Your server's public URL
|
||||
config_url="https://.../.well-known/openid-configuration", # Your MCP Server .well-known URL
|
||||
base_url=SERVER_URL, # Your server's public URL
|
||||
)
|
||||
|
||||
# Create FastMCP server with auth
|
||||
|
|
|
|||
|
|
@ -220,7 +220,7 @@ Because FastMCP's FastAPI integration is based on its [OpenAPI integration](/int
|
|||
```python
|
||||
# Assumes the FastAPI app from above is already defined
|
||||
from fastmcp import FastMCP
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
# Custom mapping rules
|
||||
mcp = FastMCP.from_fastapi(
|
||||
|
|
|
|||
|
|
@ -178,8 +178,8 @@ if __name__ == "__main__":
|
|||
|
||||
If you try to call the authenticated server with the same OpenAI code we wrote earlier, you'll get an error like this:
|
||||
|
||||
```python
|
||||
pythonAPIStatusError: Error code: 424 - {
|
||||
```text
|
||||
APIStatusError: Error code: 424 - {
|
||||
"error": {
|
||||
"message": "Error retrieving tool list from MCP server: 'dice_server'. Http status code: 401 (Unauthorized)",
|
||||
"type": "external_connector_error",
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ Each `RouteMap` specifies a combination of methods, patterns, and tags, as well
|
|||
Here is FastMCP's default rule:
|
||||
|
||||
```python
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
DEFAULT_ROUTE_MAPPINGS = [
|
||||
# All routes become tools
|
||||
|
|
@ -101,7 +101,7 @@ For example, prior to FastMCP 2.8.0, GET requests were automatically mapped to `
|
|||
|
||||
```python
|
||||
from fastmcp import FastMCP
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
# Restore pre-2.8.0 semantic mapping
|
||||
semantic_maps = [
|
||||
|
|
@ -124,7 +124,7 @@ Here is a more complete example that uses custom route maps to convert all `GET`
|
|||
|
||||
```python
|
||||
from fastmcp import FastMCP
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
mcp = FastMCP.from_openapi(
|
||||
openapi_spec=spec,
|
||||
|
|
@ -164,7 +164,7 @@ You can use this to remove sensitive or internal routes by targeting them specif
|
|||
|
||||
```python
|
||||
from fastmcp import FastMCP
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
mcp = FastMCP.from_openapi(
|
||||
openapi_spec=spec,
|
||||
|
|
@ -180,7 +180,7 @@ Or you can use a catch-all rule to exclude everything that your maps don't handl
|
|||
|
||||
```python
|
||||
from fastmcp import FastMCP
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
mcp = FastMCP.from_openapi(
|
||||
openapi_spec=spec,
|
||||
|
|
@ -212,7 +212,8 @@ The `route_map_fn` is called on all routes, even those that matched `MCPType.EXC
|
|||
|
||||
```python
|
||||
from fastmcp import FastMCP
|
||||
from fastmcp.server.openapi import RouteMap, MCPType, HTTPRoute
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
from fastmcp.utilities.openapi import HTTPRoute
|
||||
|
||||
def custom_route_mapper(route: HTTPRoute, mcp_type: MCPType) -> MCPType | None:
|
||||
"""Advanced route type mapping."""
|
||||
|
|
@ -277,7 +278,7 @@ FastMCP provides several ways to add tags to your MCP components, allowing you t
|
|||
You can add custom tags to components created from specific routes using the `mcp_tags` parameter in `RouteMap`. These tags will be applied to all components created from routes that match that particular route map.
|
||||
|
||||
```python
|
||||
from fastmcp.server.openapi import RouteMap, MCPType
|
||||
from fastmcp.server.providers.openapi import RouteMap, MCPType
|
||||
|
||||
mcp = FastMCP.from_openapi(
|
||||
openapi_spec=spec,
|
||||
|
|
@ -368,12 +369,12 @@ Your `mcp_component_fn` is expected to modify the component in-place, not to ret
|
|||
</Tip>
|
||||
|
||||
```python
|
||||
from fastmcp.server.openapi import (
|
||||
HTTPRoute,
|
||||
from fastmcp.server.providers.openapi import (
|
||||
OpenAPITool,
|
||||
OpenAPIResource,
|
||||
OpenAPIResourceTemplate,
|
||||
)
|
||||
from fastmcp.utilities.openapi import HTTPRoute
|
||||
|
||||
def customize_components(
|
||||
route: HTTPRoute,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue