MCP Framework

🚀 MCP Framework Guide

The MCP framework is a powerful tool designed to simplify the development of real-time communication applications. It supports multiple transport protocols (such as SSE and HTTP streaming) and offers a rich set of functional modules, including authentication, logging, and error handling.

🚀 Quick Start

📦 Installation

npm install mcp-framework

💻 Usage Examples

Basic Usage

import { MCPServer } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      port: 3000,
      host: 'localhost'
    }
  }
});

server.start();

Run the Example

node index.js

✨ Features

The MCP framework implements modular functionality through a middleware mechanism. Users can select different middleware according to their needs to extend the service.

🔧 SSE Transport Configuration

SSE (Server-Sent Events) is a protocol for real-time communication, suitable for application scenarios that require a continuous data stream.

Basic Configuration

import { MCPServer } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      port: 3000,
      host: 'localhost'
    }
  }
});

server.start();

Advanced Configuration

import { MCPServer, SSETransportOptions } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      port: 3000,
      host: 'localhost',
      path: '/events',
      maxReconnectionDelay: 5000
    }
  }
});

server.start();

🔧 HTTP Stream Transport Configuration

HTTP stream transport is suitable for scenarios that require handling large file uploads and downloads.

Basic Configuration

import { MCPServer } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'http-stream',
    options: {
      port: 3000,
      host: 'localhost'
    }
  }
});

server.start();

Advanced Configuration

import { MCPServer, HTTPStreamOptions } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'http-stream',
    options: {
      port: 3000,
      host: 'localhost',
      path: '/stream',
      responseMode: 'batch',
      batchTimeout: 30000
    }
  }
});

server.start();

🔐 Authentication

The MCP framework supports multiple authentication methods, including JWT and API Key.

JWT Authentication Configuration

import { MCPServer, JWTAuthProvider } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      auth: {
        provider: new JWTAuthProvider({
          secret: process.env.JWT_SECRET,
          algorithms: ['HS256']
        }),
        endpoints: {
          sse: true
        }
      }
    }
  }
});

server.start();

API Key Authentication Configuration

import { MCPServer, APIKeyAuthProvider } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      auth: {
        provider: new APIKeyAuthProvider({
          secret: process.env.API_KEY_SECRET
        })
      }
    }
  }
});

server.start();

📝 Logging

The MCP framework provides built-in logging functionality to assist developers in debugging and monitoring services.

Enable Logging

import { MCPServer, Logger } from 'mcp-framework';

const logger = new Logger({
  level: 'info',
  handlers: [
    {
      type: 'file',
      path: './logs/app.log'
    }
  ]
});

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      port: 3000,
      host: 'localhost'
    }
  },
  logger
});

server.start();

🛠️ Error Handling

The MCP framework offers a powerful error handling mechanism to help developers quickly locate and resolve issues.

Custom Error Handler

import { MCPServer } from 'mcp-framework';

const server = new MCPServer({
  transport: {
    type: 'sae',
    options: {
      port: 3000,
      host: 'localhost'
    }
  },
  errorHandlers: [
    (error, context) => {
      console.error('Custom error handler:', error);
      context.reply(500, 'Internal Server Error');
    }
  ]
});

server.start();

📚 Summary

The MCP framework simplifies the development process of real-time communication applications by providing flexible configuration and powerful functional modules. Whether using SSE or HTTP stream transport, users can choose the appropriate solution according to their needs and extend the service functionality through a rich set of middleware.