MCP Server Com Sse E Autenticacao Bearer

🚀 Model Context Protocol Server with SSE and Bearer Authentication

This project is an implementation of an MCP (Model Context Protocol) server developed in TypeScript. It enables real-time communication through Server-Sent Events (SSE) and uses Bearer Token for authentication. The project has a clear structure and well-defined functional modules.

🚀 Quick Start

Set up the development environment

1. Clone the repository to your local machine:

   git clone [Repository URL]
   cd mcp-server
   

2. Install the dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

Deploy in the production environment

1. Compile the project:

   npm run build
   

2. Run the compiled file:

   node dist/index.js
   

✨ Features

• Real-time communication: Utilizes SSE technology for long polling, ensuring low-latency message delivery.
• Authentication: Employs Bearer Token for stateless authentication, enhancing security.
• Modular structure: Each functional module is developed independently, facilitating maintenance and expansion.
• Scalability: Supports the addition of new tools and services, flexibly adapting to different requirements.

📦 Installation

• Node.js & npm: Make sure to install the latest stable version (recommended v14 and above).
• ts-node: Used for directly running TypeScript files.
• @types/express: Type definitions for the Express framework.
• express: The basic Web framework.
• ws: Supports WebSocket communication.

📚 Documentation

Project Architecture

Core Modules

• MCP Module: Responsible for creating and configuring MCP server instances, managing tool registration, and SSE connections.
• Middleware: Provides Bearer Token authentication, CORS support, and request parsing functions.
• Routes: Implements the processing logic for the main interfaces /sse and /messages.
• Configuration files: Define key parameters such as the server port and session expiration time.
• Application layer: Coordinates the collaborative work of each module to ensure the normal operation of the server.

System Flow

1. Establish a connection:

   • The client sends a GET /sse request to the server to establish an SSE channel and provides a Bearer Token for authentication.
   • After verifying the Token, the server creates a new SSE transmission instance and assigns a unique session ID to the client.
   • The MCP server connects to the SSE transmission instance, initializes the communication, and sends initial messages such as the tool list.

2. Message processing:

   • The client sends a message request containing the session ID to the /messages interface.
   • The server searches for the corresponding SSE transmission instance based on the session ID and forwards the received message to the MCP server for processing.
   • After processing, the response result is sent back to the client through the SSE channel.

3. Disconnect:

   • When the client closes the SSE connection, the server detects the status change and cleans up the transmission instance corresponding to the session ID.

Sequence Diagram

The following is the interaction flow chart of the project:

@startuml

title "Communication Flow of MCP Server with SSE and Bearer Authentication"

actor "MCP Client" as Client

participant "Express Server" as Express
participant "Auth Middleware" as Auth
participant "Route /sse" as SSERoute
participant "SSE Transmission Layer" as SSE
participant "MCP Server" as MCP
participant "Route /messages" as MsgRoute

== Establish a connection ==
Client -> Express: GET /sse\n(Authorization: Bearer <token>)
Express -> Auth: Verify Bearer Token
Auth -> Client: 200 OK
Client -> SSERoute: Establish SSE channel
SSERoute -> SSE: Create transmission instance
SSE -> MCP: Initialize connection

== Send a message ==
Client -> MsgRoute: POST /messages\n(Session ID)
MsgRoute -> SSE: Get transmission instance
SSE -> MCP: Forward message
MCP -> SSE: Return processing result
SSE -> Client: Receive response

== Disconnect ==
Client -> SSE: Close channel
SSE -> SSERoute: Notify disconnection
SSERoute -> Express: Clean up resources

@enduml

Project Advantages

• High performance: Based on the Express framework, it has excellent performance.
• Security: The Bearer Token authentication mechanism ensures communication security.
• Ease of use: Provides simple API interfaces for easy integration and use.

Future Outlook

The following features are planned to be added in the future:

1. Support for the WebSocket protocol to improve communication efficiency.
2. Implementation of a message queue mechanism to increase system throughput.
3. Addition of logging and monitoring modules for easy operation and maintenance management.