Note: these docs were AI generated based on a claude code transcript, and then edited manually for accuracy
A comprehensive example implementation of a scalable Model Context Protocol (MCP) server that demonstrates all MCP functionality with full authentication support and horizontal scalability.
The Everything Server is an open-source reference implementation that showcases:
- Complete MCP Protocol Support: All MCP features including tools, resources, prompts, sampling, completions, and logging
- Multiple Transport Methods: Streamable HTTP (SHTTP) and Server-Sent Events (SSE)
- Comprehensive Auth: OAuth 2.0 with fake upstream provider for testing
- Horizontal Scalability: Redis-backed session management for multi-instance deployments
This server serves as both primarily as a learning resource, and an example implementation of a scalable remote MCP server.
- Tools: 7 demonstration tools including echo, add, long-running operations, LLM sampling, image handling, annotations, and resource references
- Resources: 100 example resources with pagination, templates, and subscription support
- Prompts: Simple and complex prompts with argument support and resource embedding
- Sampling: Integration with MCP sampling for LLM interactions
- Completions: Auto-completion support for prompt arguments
- Logging: Multi-level logging with configurable verbosity
- Notifications: Progress updates, resource updates, and stderr messages
- Streamable HTTP: Full implementation with GET/POST/DELETE support
- SSE Transport: Backwards-compatible Server-Sent Events
- Redis Integration: Pub/sub message routing and session state management
- Session Management: 5-minute TTL with automatic cleanup
- Horizontal Scaling: Any instance can handle any request
- OAuth 2.0: Complete authorization flow with PKCE support
- Fake Auth Provider: Built-in testing provider with localStorage user management
- Session Ownership: User isolation and access control
- Security Headers: CSP, HSTS, X-Frame-Options, and more
- Bearer Token Auth: Middleware for protected endpoints
- Node.js >= 16
- Redis server
- npm or yarn
# Clone the repository git clone https://github.com/modelcontextprotocol/example-remote-server.git cd example-remote-server # Install dependencies npm install # Configure environment (optional) cp .env.example .env # Edit .env with your settingsEnvironment variables (.env file):
PORT=3232 # Server port BASE_URI=http://localhost:3232 # Base URI for OAuth redirects REDIS_HOST=localhost # Redis server host REDIS_PORT=6379 # Redis server port REDIS_PASSWORD= # Redis password (if required) # Start development server with hot reload npm run dev # Start development server with debugging npm run dev:break # Build TypeScript to JavaScript npm run build # Run production server npm start # Run linting npm run lint # Run tests npm test├── src/ │ ├── index.ts # Express app setup and routes │ ├── config.ts # Configuration management │ ├── redis.ts # Redis client setup │ ├── auth/ │ │ └── provider.ts # OAuth auth provider implementation │ ├── handlers/ │ │ ├── shttp.ts # Streamable HTTP handler │ │ ├── sse.ts # SSE transport handler │ │ ├── fakeauth.ts # Fake upstream auth handler │ │ └── common.ts # Shared middleware │ ├── services/ │ │ ├── mcp.ts # MCP server implementation │ │ ├── auth.ts # Session ownership management │ │ └── redisTransport.ts # Redis-backed transport │ └── utils/ │ └── logger.ts # Structured logging ├── docs/ │ ├── streamable-http-design.md # SHTTP implementation details │ └── user-id-system.md # Authentication flow documentation ├── scratch/ # Development scripts and tests └── dist/ # Compiled JavaScript output GET/POST/DELETE /mcp- Streamable HTTP transport endpointPOST: Initialize sessions or send messagesGET: Establish SSE streamsDELETE: Terminate sessions
GET /sse- Legacy SSE transport endpointPOST /message- Legacy message endpoint for SSE transport
GET /fakeupstreamauth/authorize- Fake OAuth authorization pageGET /fakeupstreamauth/redirect- OAuth redirect handler- OAuth 2.0 endpoints provided by MCP SDK auth router
Mcp-Session-Id: Session identifier for Streamable HTTPAuthorization: Bearer <token>: OAuth access token- Standard MCP headers as per protocol specification
The server implements a complete OAuth 2.0 flow with a fake upstream provider for testing:
- Client Registration: Clients register to obtain client_id and client_secret
- Authorization: Users authenticate through
/fakeupstreamauth/authorize - User Management: localStorage-based user ID system for testing
- Token Exchange: Authorization codes exchanged for access tokens
- Session Creation: Authenticated tokens create owned sessions
- Access Control: Sessions are isolated by user ownership
See docs/user-id-system.md for detailed authentication documentation.
Modern transport supporting bidirectional communication over HTTP:
- Single endpoint for all operations
- Session management via headers
- Efficient message buffering
- Automatic reconnection support
See docs/streamable-http-design.md for implementation details.
Backwards-compatible transport using SSE:
- Separate endpoints for SSE streams and messages
- Session management via URL parameters
- Redis-backed message routing
- Real-time event delivery
The server is designed for horizontal scaling using Redis as the backbone:
- Redis Storage: All session state stored in Redis
- 5-minute TTL: Automatic session cleanup
- Session Ownership: User isolation via Redis keys
- Stateless Servers: Any instance can handle any request
- Pub/Sub Channels: Redis channels for message distribution
- Message Buffering: Reliable delivery for disconnected clients
- Connection State: Tracked via pub/sub subscription counts
- Automatic Cleanup: No explicit cleanup required
session:{sessionId}:owner # Session ownership mcp:shttp:toserver:{sessionId} # Client→Server messages mcp:shttp:toclient:{sessionId}:{requestId} # Server→Client responses mcp:control:{sessionId} # Control messages # Run all tests npm test # Run specific test suites npm test -- --testNamePattern="User Session Isolation" npm test -- --testNamePattern="session ownership" # Run with coverage npm test -- --coverage- Unit Tests: Individual component testing
- Integration Tests: Transport and Redis integration
- Auth Tests: OAuth flow and session ownership
- Multi-user Tests: User isolation and access control
The scratch/ directory contains utility scripts for testing:
oauth.sh- Test OAuth flowssimple-test-client.js- Basic client implementationtest-shttp-client.ts- Streamable HTTP testingdebug-mcp-flow.sh- Debug MCP message flows
- Authentication: OAuth 2.0 with bearer tokens
- Authorization: User-based session ownership
- Session Isolation: Users can only access their own sessions
- Security Headers:
- Content Security Policy (CSP)
- Strict Transport Security (HSTS)
- X-Frame-Options
- X-Content-Type-Options
- Input Validation: Zod schemas for all inputs
- Error Handling: Sanitized error responses
- Always use HTTPS in production
- Configure proper CORS origins
- Use strong client secrets
- Enable all security headers
- Monitor session lifetimes
- Implement rate limiting
- Use structured logging
Structured JSON logging with sanitized outputs:
- HTTP request/response logging
- Authentication events
- Session lifecycle events
- Redis operations
- Error tracking
# Monitor session ownership redis-cli KEYS "session:*:owner" # Watch real-time operations redis-cli MONITOR | grep "session:" # Check active sessions redis-cli PUBSUB CHANNELS "mcp:shttp:toserver:*" # Debug specific session redis-cli GET "session:{sessionId}:owner"- Development scripts in
scratch/directory - Comprehensive test suite
- Hot-reload development mode
- Source maps for debugging
We welcome contributions! Please see our Contributing Guidelines for details.
- Fork the repository
- Create a feature branch
- Implement your changes
- Add tests for new functionality
- Ensure all tests pass
- Run linting and fix issues
- Submit a pull request
- TypeScript with strict mode
- ESLint configuration included
- Prettier formatting recommended
- Comprehensive type definitions
This project is licensed under the MIT License - see the LICENSE file for details.
Built by the Model Context Protocol team as a reference implementation for the MCP ecosystem.