MCP Framework

🚀 MCP 框架指南

MCP 框架是一款功能強大的工具，旨在簡化即時通信應用的開發。它支持多種傳輸協議，如 SSE 和 HTTP 流，還提供了豐富的功能模塊，涵蓋認證、日誌記錄和錯誤處理等方面，能有效提升開發效率。

🚀 快速開始

📦 安裝指南

使用以下命令安裝 MCP 框架的依賴：

npm install mcp-framework

💻 使用示例

基礎用法

創建一個基本的 MCP 服務：

import { MCPServer } from 'mcp-framework';

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

server.start();

運行示例

使用以下命令運行示例代碼：

node index.js

✨ 主要特性

核心概念

MCP 框架藉助中間件機制實現模塊化功能。用戶能夠依據自身需求挑選不同的中間件，對服務進行擴展。

SSE 傳輸配置

SSE（Server-Sent Events）是一種用於即時通信的協議，適用於需要持續數據流的應用場景。

基本配置

import { MCPServer } from 'mcp-framework';

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

server.start();

高級配置

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 流傳輸配置

HTTP 流傳輸適用於需要處理大文件上傳和下載的場景。

基本配置

import { MCPServer } from 'mcp-framework';

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

server.start();

高級配置

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();

認證

MCP 框架支持多種認證方式，包括 JWT 和 API Key。

JWT 認證配置

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 認證配置

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();

日誌記錄

MCP 框架提供內置日誌記錄功能，有助於開發者調試和監控服務。

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();

錯誤處理

MCP 框架具備強大的錯誤處理機制，可幫助開發者快速定位並解決問題。

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();

📚 詳細文檔

MCP 框架通過提供靈活的配置和強大的功能模塊，極大地簡化了即時通信應用的開發過程。無論是採用 SSE 還是 HTTP 流傳輸，用戶都能根據實際需求選擇合適的方案，並且可以通過豐富的中間件對服務功能進行擴展。