Skip to content

Use consistent Streamable HTTP wording #2504

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aolingge wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −7
Open

Use consistent Streamable HTTP wording #2504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
- [Streamable HTTP Transport](#streamable-http-transport)
- [CORS Configuration for Browser-Based Clients](#cors-configuration-for-browser-based-clients)
- [Mounting to an Existing ASGI Server](#mounting-to-an-existing-asgi-server)
- [StreamableHTTP servers](#streamablehttp-servers)
- [Streamable HTTP servers](#streamablehttp-servers)
- [Basic mounting](#basic-mounting)
- [Host-based routing](#host-based-routing)
- [Multiple servers with path configuration](#multiple-servers-with-path-configuration)
Expand Down Expand Up @@ -1387,16 +1387,16 @@ By default, SSE servers are mounted at `/sse` and Streamable HTTP servers are mo

For more information on mounting applications in Starlette, see the [Starlette documentation](https://www.starlette.io/routing/#submounting-routes).

#### StreamableHTTP servers
#### Streamable HTTP servers

You can mount the StreamableHTTP server to an existing ASGI server using the `streamable_http_app` method. This allows you to integrate the StreamableHTTP server with other ASGI applications.
You can mount the Streamable HTTP server to an existing ASGI server using the `streamable_http_app` method. This allows you to integrate the Streamable HTTP server with other ASGI applications.

##### Basic mounting

<!-- snippet-source examples/snippets/servers/streamable_http_basic_mounting.py -->
```python
"""
Basic example showing how to mount StreamableHTTP server in Starlette.
Basic example showing how to mount Streamable HTTP server in Starlette.

Run from the repository root:
uvicorn examples.snippets.servers.streamable_http_basic_mounting:app --reload
Expand Down Expand Up @@ -1426,7 +1426,7 @@ async def lifespan(app: Starlette):
yield


# Mount the StreamableHTTP server to the existing ASGI server
# Mount the Streamable HTTP server to the existing ASGI server
app = Starlette(
routes=[
Mount("/", app=mcp.streamable_http_app()),
Expand All @@ -1443,7 +1443,7 @@ _Full example: [examples/snippets/servers/streamable_http_basic_mounting.py](htt
<!-- snippet-source examples/snippets/servers/streamable_http_host_mounting.py -->
```python
"""
Example showing how to mount StreamableHTTP server using Host-based routing.
Example showing how to mount Streamable HTTP server using Host-based routing.

Run from the repository root:
uvicorn examples.snippets.servers.streamable_http_host_mounting:app --reload
Expand Down Expand Up @@ -1490,7 +1490,7 @@ _Full example: [examples/snippets/servers/streamable_http_host_mounting.py](http
<!-- snippet-source examples/snippets/servers/streamable_http_multiple_servers.py -->
```python
"""
Example showing how to mount multiple StreamableHTTP servers with path configuration.
Example showing how to mount multiple Streamable HTTP servers with path configuration.

Run from the repository root:
uvicorn examples.snippets.servers.streamable_http_multiple_servers:app --reload
Expand Down
Loading