feat(transport): Add new transport modes (Streamable HTTP & SSE) #33
Conversation
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
- Added support for HTTP transport in the MCP server, allowing communication via HTTP requests. - Introduced a new `HttpTransport` class that handles incoming requests and manages sessions. - Updated CLI options to include transport type selection, defaulting to stdio. - Enhanced environment schema to configure HTTP host and port. - Refactored the main server logic to utilize the selected transport type, improving flexibility in deployment. - Added a base transport class to standardize transport implementations.
- Introduced a `TransportManager` class to manage multiple transport types (HTTP, SSE, STDIO) for the MCP server. - Updated CLI options to allow selection of multiple transport types, improving flexibility in deployment. - Refactored the `HttpTransport` and added a new `SseTransport` class for handling Server-Sent Events. - Enhanced environment variable loading and error handling in the CLI. - Removed the obsolete `BaseTransport` class and factory pattern, simplifying transport management. - Updated package dependencies to include `@fastify/swagger` and `@fastify/swagger-ui` for API documentation. - Improved logging configuration to default to debug level for better traceability.
…ection management - Updated the HttpServer class to include a custom logger instance for improved logging capabilities. - Configured the server to force close ongoing connections, enhancing resource management during shutdowns. - Refactored the server initialization to accommodate the new logging setup.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the MCP Server by introducing support for multiple transport modes (HTTP, SSE, and STDIO), along with corresponding CLI, environment, and logging improvements. Key changes include:
- Addition of new transport types and implementations for HTTP (streamable), SSE, and STDIO.
- Introduction of a TransportManager to dynamically initialize and manage these transports.
- Updates to CLI options, environment schemas, and logging configuration.
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/mcp/transports/types.ts | Introduces transport types and shared interfaces for the transports. |
| src/mcp/transports/stdio.ts | Implements the STDIO transport. |
| src/mcp/transports/sse.ts | Implements the SSE transport endpoints and session management. |
| src/mcp/transports/http.ts | Implements the streamable HTTP transport with session handling. |
| src/mcp/transports/server.ts | Sets up an HTTP server with Swagger documentation. |
| src/mcp/transports/manager.ts | Provides lifecycle management for starting/stopping transports. |
| src/cli.ts | Updates CLI parsing to accept comma-separated transport types. |
| src/env-schema.ts | Adds HTTP transport configuration to the environment schema. |
| src/logger.ts | Changes default logging level from info to debug. |
| src/index.ts | Initializes the TransportManager and updates tool handler invocations. |
| package.json | Adds npm scripts for starting the server with different transport modes. |
Comment on lines
+141
to
+142
| Object.values(this.sessions).forEach((transport) => { | ||
| const sessionId = transport.sessionId; |
There was a problem hiding this comment.
The 'this.sessions' variable is a Map, so using Object.values() may not iterate over the stored transports as expected. Consider using 'this.sessions.forEach((transport, sessionId) => { ... })' or iterating over 'this.sessions.values()' for correct behavior.
Suggested change
| Object.values(this.sessions).forEach((transport) => { | |
| const sessionId = transport.sessionId; | |
| this.sessions.forEach((transport, sessionId) => { |
Copilot uses AI. Check for mistakes.
eddyv
commented
May 9, 2025
src/confluent/helpers.ts
Outdated
There was a problem hiding this comment.
Modifications of this file were necessary to help remove typing errors now that we've introduced a number type to our env-schema.
Prevents issues when accessing env.* when our client args would expect a string type and not a string | number
eddyv
commented
May 9, 2025
Comment on lines
+17
to
+18
| // Useful for when ongoing http/sse connections are present | ||
| forceCloseConnections: true, |
There was a problem hiding this comment.
Still not sure if this is better or if it's better for us to modify keep alive time
…orts before disconnecting clients
pascalconfluent
approved these changes
May 9, 2025
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 pull request introduces enhancements to the CLI, transport system, and overall server architecture, enabling support for multiple transport protocols (HTTP, SSE, and Stdio) and improving configurability and error handling. The changes also include updates to the logging level, environment schema, and tool handler interfaces.
CLI and Environment Configuration Enhancements:
--transport) with validation and parsing logic for multiple transport protocols (src/cli.ts).HTTP_PORTandHTTP_HOST) with default values.Transport System Overhaul:
TransportManagerto manage multiple transport protocols (HTTP, SSE, Stdio) with start/stop lifecycle management (src/mcp/transports/manager.ts).HttpTransportto handle HTTP-based MCP sessions, including POST, GET, and DELETE endpoints for session management (src/mcp/transports/http.ts).index.tsto initialize and manage transports dynamically based on CLI options and environment variables.Tool Handler Improvements:
sessionIdparameter for session-specific operations, improving flexibility for tools like Kafka message consumption.Logging and Debugging:
infotodebugto provide more detailed runtime information.Dependency and Build Updates:
@fastify/swagger,@fastify/swagger-ui, andfastifydependencies to support HTTP transport and API documentation (package.json).start:http,start:sse,start:all,help) to facilitate transport-specific server startups.Testing
Tested using https://github.com/modelcontextprotocol/inspector (for streamable http & sse) and goose cli (sse). Not all clients support streamable http mode yet.