Skip to content

Commit e934c10

Browse files
committed
update readme and changelog
1 parent 3daab18 commit e934c10

File tree

2 files changed

+76
-1
lines changed

2 files changed

+76
-1
lines changed

CHANGELOG.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [Unreleased]
9+
10+
### Changed
11+
- Complete refactor from function-based API to a new class-based API with `FastApiMCP`
12+
- Explicit separation between MCP instance creation and mounting with `mcp = FastApiMCP(app)` followed by `mcp.mount()`
13+
- FastAPI-native approach for transport providing more flexible routing options
14+
- Updated minimum MCP dependency to v1.6.0
15+
16+
### Added
17+
- Support for deploying MCP servers separately from API service
18+
- Support for "refreshing" with `setup_server()` when dynamically adding FastAPI routes. Fixes [Issue #19](https://github.com/tadata-org/fastapi_mcp/issues/19)
19+
- Endpoint filtering capabilities through new parameters:
20+
- `include_operations`: Expose only specific operations by their operation IDs
21+
- `exclude_operations`: Expose all operations except those with specified operation IDs
22+
- `include_tags`: Expose only operations with specific tags
23+
- `exclude_tags`: Expose all operations except those with specific tags
24+
25+
### Fixed
26+
- FastAPI-native approach for transport. Fixes [Issue #28](https://github.com/tadata-org/fastapi_mcp/issues/28)
27+
- Numerous bugs in OpenAPI schema to tool conversion, addressing [Issue #40](https://github.com/tadata-org/fastapi_mcp/issues/40) and [Issue #45](https://github.com/tadata-org/fastapi_mcp/issues/45)
28+
29+
### Removed
30+
- Function-based API (`add_mcp_server`, `create_mcp_server`, etc.)
31+
- Custom tool support via `@mcp.tool()` decorator
32+
833
## [0.1.8]
934

1035
### Fixed
@@ -73,4 +98,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7398
- Claude integration for easy installation and use
7499
- API integration that automatically makes HTTP requests to FastAPI endpoints
75100
- Examples directory with sample FastAPI application
76-
- Basic test suite
101+
- Basic test suite

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,56 @@ mcp = FastApiMCP(
110110
mcp.mount()
111111
```
112112

113+
### Customizing Exposed Endpoints
114+
115+
You can control which FastAPI endpoints are exposed as MCP tools using Open API operation IDs or tags:
116+
117+
```python
118+
from fastapi import FastAPI
119+
from fastapi_mcp import FastApiMCP
120+
121+
app = FastAPI()
122+
123+
# Only include specific operations
124+
mcp = FastApiMCP(
125+
app,
126+
include_operations=["get_user", "create_user"]
127+
)
128+
129+
# Exclude specific operations
130+
mcp = FastApiMCP(
131+
app,
132+
exclude_operations=["delete_user"]
133+
)
134+
135+
# Only include operations with specific tags
136+
mcp = FastApiMCP(
137+
app,
138+
include_tags=["users", "public"]
139+
)
140+
141+
# Exclude operations with specific tags
142+
mcp = FastApiMCP(
143+
app,
144+
exclude_tags=["admin", "internal"]
145+
)
146+
147+
# Combine operation IDs and tags (include mode)
148+
mcp = FastApiMCP(
149+
app,
150+
include_operations=["user_login"],
151+
include_tags=["public"]
152+
)
153+
154+
mcp.mount()
155+
```
156+
157+
Notes on filtering:
158+
- You cannot use both `include_operations` and `exclude_operations` at the same time
159+
- You cannot use both `include_tags` and `exclude_tags` at the same time
160+
- You can combine operation filtering with tag filtering (e.g., use `include_operations` with `include_tags`)
161+
- When combining filters, a greedy approach will be taken. Endpoints matching either criteria will be included
162+
113163
### Deploying Separately from Original FastAPI App
114164

115165
You are not limited to serving the MCP on the same FastAPI app from which it was created.

0 commit comments

Comments
 (0)