ceos/fastmcp
1
0
Fork 0
mirror of https://github.com/PrefectHQ/fastmcp.git synced 2026-08-21 04:54:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'main' into content-length

Browse source
This commit is contained in:
Jeremiah Lowin 2025-05-24 07:44:07 -04:00 • committed by GitHub
commit f8b52e736a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/servers/openapi.mdx
View file

@ -51,13 +51,7 @@ FastMCP analyzes your API specification and automatically creates MCP components
| `GET` without path params | `GET /stats` | **Resource** |
| `POST`, `PUT`, `PATCH`, `DELETE`, etc. | `POST /users` | **Tool** |
### Custom Route Maps
<VersionBadge version="2.5.0" />
FastMCP uses an ordered list of `RouteMap` objects to determine how to map OpenAPI routes to various MCP component types.
Interally, FastMCP uses an ordered list of `RouteMap` objects to determine how to map OpenAPI routes to various MCP component types.
Each `RouteMap` specifies a combination of methods, patterns, and tags, as well as a corresponding MCP component type. Each OpenAPI route is checked against each `RouteMap` in order, and the first one that matches every criteria is used to determine its converted MCP type. A special type, `EXCLUDE`, can be used to exclude routes from the MCP server entirely.
@ -66,7 +60,7 @@ Each `RouteMap` specifies a combination of methods, patterns, and tags, as well
- **Tags**: A set of OpenAPI tags that must all be present. An empty set (`{}`) means no tag filtering, so the route matches regardless of its tags.
- **MCP type**: What MCP component type to create (`TOOL`, `RESOURCE`, `RESOURCE_TEMPLATE`, or `EXCLUDE`)
To illustrate this in practice, here are FastMCP's default route mappings as a list of `RouteMap` objects:
To illustrate this in practice, here are FastMCP's default rules as a list of `RouteMap` objects:
```python
from fastmcp.server.openapi import RouteMap, MCPType