feat: Add Multi-Instance Support via Custom Channel Builders #186
+589
−2
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
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
currently working on tweaks to the tests |
## Overview
This PR adds support for running multiple SSE server instances with
shared state. It introduces a flexible, technology-agnostic approach
using channel builders that allow for distributed message delivery
across server instances.
## Key Features
- **Custom Event Queue Builders**: Allow customizing how server-sent
events are distributed across instances
- **Custom Notification Channel Builders**: Support distributed
notification delivery
- **Redis Implementation**: Provides a ready-to-use implementation using
Redis pub/sub
- **No Core Dependencies**: Maintains zero external dependencies in the
core library
- **Comprehensive Tests**: Includes tests using a mock broker to verify
functionality
## Technical Approach
Rather than tightly coupling the library to a specific technology (like
Redis), this PR introduces builder functions that can create custom
communication channels:
```go
// Create a multi-instance SSE server using Redis
sseServer := server.NewSSEServer(
mcpServer,
server.WithBaseURL("https://api.example.com"),
server.NewRedisEventQueueBuilder(redisClient),
server.NewRedisNotificationChannelBuilder(redisClient),
)
```
This approach has several advantages:
- Users can implement different message broker solutions (Redis,
RabbitMQ, SQS, etc.)
- The core library remains focused and dependency-free
- Testing is simplified using mock implementations
## Implementation Notes
- Channel builders are executed once per SSE session
- The Redis implementation uses pub/sub for real-time message delivery
- Communication channels are bidirectional for both producing and
consuming messages
- Tests use a mock broker to verify multi-instance behavior without
external dependencies
## Example Usage
```go
import (
"github.com/go-redis/redis/v8"
"github.com/mark3labs/mcp-go/server"
)
func createMultiInstanceServer() *server.SSEServer {
// Connect to Redis
redisClient := redis.NewClient(&redis.Options{
Addr: "redis:6379",
})
// Create MCP server
mcpServer := server.NewMCPServer(
"my-app",
"1.0.0",
server.WithToolCapabilities(true),
)
// Create SSE server with Redis-backed channels
return server.NewSSEServer(
mcpServer,
server.WithBaseURL("https://api.example.com"),
server.NewRedisEventQueueBuilder(redisClient),
server.NewRedisNotificationChannelBuilder(redisClient),
)
}
```
This solution enables horizontally scaling SSE servers while maintaining
session consistency across instances.
robert-jackson-glean
force-pushed
the
rwjblue/push-vmwzzpyrwvlq
branch
from
2faa151 to
aa44ce7
Compare
clayallsopp
added a commit
to clayallsopp/mcp-go
that referenced
this pull request
Apr 25, 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.
Overview
This PR adds support for running multiple SSE server instances with shared state. It introduces a flexible, technology-agnostic approach using channel builders that allow for distributed message delivery across server instances.
Key Features
Technical Approach
Rather than tightly coupling the library to a specific technology (like Redis), this PR introduces builder functions that can create custom communication channels:
This approach has several advantages:
Implementation Notes
Example Usage
This solution enables horizontally scaling SSE servers while maintaining session consistency across instances.