Add StreamableHTTPServerTransport documentation to README#19
Merged
Conversation
Co-authored-by: syucream <191684+syucream@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Describe how to use Streamable HTTP transport in README
Add StreamableHTTPServerTransport documentation to README
May 31, 2025
Owner
|
@copilot describe how to connect popular MCP clients like Claude Desktop to http mcp remote server, like the stdio case. I guess the clients now typically accept |
Co-authored-by: syucream <191684+syucream@users.noreply.github.com>
Contributor
Author
Added Claude Desktop HTTP configuration documentation showing how to use the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive documentation for the existing HTTP transport functionality that was previously undocumented.
Changes Made
Documentation Updates
-portflag to start HTTP modeStreamableHTTPClientTransportnpm run dev:httpLIGHTDASH_API_KEYandLIGHTDASH_API_URLmust be set in the server environment for HTTP modeExample Code
examples/list_spaces_http.ts- a complete working example demonstrating HTTP client usageBefore/After
Before: README only documented stdio transport mode, with no mention of HTTP capabilities
After: Clear documentation for both transport modes:
The server already supported both transports, but users had no way to discover or properly use the HTTP functionality.
Fixes #18.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.