Skip to content

Commit 5de520d

Browse files
authored
docs: fix transport default (#94)
1 parent 04bb99d commit 5de520d

File tree

4 files changed

+30
-6
lines changed

4 files changed

+30
-6
lines changed

CHANGELOG.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [0.4.3] - 2025-06-24
11+
12+
### Added
13+
- HTTP transport via `app.run(transport="streamable-http")`
14+
- Basic memory example demonstrating `FileMemoryStore`
15+
- `mcp_use` client for the hello_world example
16+
1017
### Changed
11-
- List relationship resolvers generated from SQLAlchemy models now return
12-
`PageResult` using `page` and `page_size` parameters without performing
13-
count queries. `total_items` is omitted and `has_next` is inferred from
14-
the query results.
18+
- SQLAlchemy relationship resolvers now return `PageResult` using
19+
`page` and `page_size` parameters without count queries.
20+
21+
### Fixed
22+
- Correct path handling in the HTTP example
1523

1624
## [0.4.2] - 2025-06-19
1725

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,15 @@ async def get_user_profile(user_id: int, context: EnrichContext) -> UserProfile:
299299
return await db.get_profile(user_id)
300300
```
301301

302+
### 🌐 HTTP & SSE Support
303+
304+
Serve your API over standard output (default), SSE, or HTTP:
305+
306+
```python
307+
app.run() # stdio default
308+
app.run(transport="streamable-http")
309+
```
310+
302311
## Why EnrichMCP?
303312

304313
EnrichMCP adds three critical layers on top of MCP:
@@ -320,6 +329,7 @@ Check out the [examples directory](examples/README.md):
320329
- [shop_api_gateway](examples/shop_api_gateway) - EnrichMCP as a gateway in front of FastAPI
321330
- [sqlalchemy_shop](examples/sqlalchemy_shop) - Auto-generated API from SQLAlchemy models
322331
- [mutable_crud](examples/mutable_crud) - Demonstrates mutable fields and CRUD decorators
332+
- [basic_memory](examples/basic_memory) - Simple note-taking API using FileMemoryStore
323333
- [openai_chat_agent](examples/openai_chat_agent) - Interactive chat client for MCP examples
324334

325335
## Documentation

docs/api/app.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,15 @@ async def delete_user(uid: int) -> bool:
100100
Start the MCP server.
101101

102102
**Parameters:**
103-
- `**options`: Options passed to FastMCP (transport, host, port, etc.)
103+
- `transport`: Transport protocol - `"stdio"`, `"sse"`, or `"streamable-http"`.
104+
- `mount_path`: Optional mount path for SSE transport.
105+
- `**options`: Additional options forwarded to FastMCP.
104106

105107
**Example:**
106108
```python
107109
if __name__ == "__main__":
108-
app.run()
110+
app.run() # stdio default
111+
app.run(transport="streamable-http")
109112
```
110113

111114
### `describe_model() -> str`

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ async def get_customer(customer_id: int) -> Customer:
5353

5454
# Run it!
5555
app.run()
56+
57+
# Serve over HTTP instead of stdio
58+
app.run(transport="streamable-http")
5659
```
5760

5861
Already using SQLAlchemy? See how to

0 commit comments

Comments
 (0)