Skip to content

StreamableHttp - update docs - #664

Merged
ihrpr merged 112 commits into
mainfrom
ihrpr/shttp-docs
May 8, 2025
Merged

StreamableHttp - update docs#664
ihrpr merged 112 commits into
mainfrom
ihrpr/shttp-docs

Conversation

@ihrpr

@ihrpr ihrpr commented May 8, 2025

Copy link
Copy Markdown
Contributor

Updating docs before the release

@ihrpr
ihrpr marked this pull request as ready for review May 8, 2025 11:31

@jerome3o-anthropic jerome3o-anthropic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌

bhosmer-ant
bhosmer-ant previously approved these changes May 8, 2025

@bhosmer-ant bhosmer-ant left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Couple v minor ideas inline but feel free to ignore

Comment thread README.md
Comment thread README.md Outdated

### Mounting to an Existing ASGI Server

> **Note**: SSE transport is being superseded by streamable HTTP transport. Consider using streamable HTTP for production deployments.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fwiw the wording here is slightly different from the prior note

Comment thread README.md Outdated
asyncio.run(run())
```

Clients can also connect using streamable HTTP transport:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idk does this deserve its own section header?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the "how should I decide what transport my client should use" noob question might come to mind here - if there's somewhere else in the docs where we cover this, it might be a nice thing to link to

Base automatically changed from ihrpr/shttp to main May 8, 2025 19:43
@ihrpr
ihrpr dismissed stale reviews from bhosmer-ant and jerome3o-anthropic May 8, 2025 19:43

The base branch was changed.

@ihrpr
ihrpr merged commit 72003d9 into main May 8, 2025
@ihrpr
ihrpr deleted the ihrpr/shttp-docs branch May 8, 2025 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants