Skip to content

Add StreamableHTTPServerTransport documentation to README#19

Merged
syucream merged 3 commits intomainfrom
copilot/fix-18
May 31, 2025
Merged

Add StreamableHTTPServerTransport documentation to README#19
syucream merged 3 commits intomainfrom
copilot/fix-18

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 31, 2025

This PR adds comprehensive documentation for the existing HTTP transport functionality that was previously undocumented.

Changes Made

Documentation Updates

  • Added HTTP Transport section to README explaining how to use StreamableHTTPServerTransport
  • Documented command line options - added documentation for the -port flag to start HTTP mode
  • Added code examples showing how to connect programmatically using StreamableHTTPClientTransport
  • Updated development scripts documentation to include npm run dev:http
  • Added environment variable notes explaining that LIGHTDASH_API_KEY and LIGHTDASH_API_URL must be set in the server environment for HTTP mode

Example Code

  • Created examples/list_spaces_http.ts - a complete working example demonstrating HTTP client usage
  • Shows proper imports and connection setup for StreamableHTTPClientTransport

Before/After

Before: README only documented stdio transport mode, with no mention of HTTP capabilities

After: Clear documentation for both transport modes:

# Stdio mode (default)
npx lightdash-mcp-server

# HTTP mode  
npx lightdash-mcp-server -port 8080

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.

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
Copilot AI requested a review from syucream May 31, 2025 12:47
@syucream
Copy link
Copy Markdown
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 url field instead of command, arg, env

Co-authored-by: syucream <191684+syucream@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 31, 2025

@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 url field instead of command, `arg...

Added Claude Desktop HTTP configuration documentation showing how to use the url field instead of command/args for connecting to the HTTP MCP server. The configuration is now documented alongside the programmatic example. Commit: ab59af0

@syucream syucream marked this pull request as ready for review May 31, 2025 15:34
@syucream syucream merged commit d4d0f1d into main May 31, 2025
1 check passed
@syucream syucream deleted the copilot/fix-18 branch May 31, 2025 15:36
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.

Describe how to use Streamable HTTP transport in README

2 participants