Zaptomcp

🚀 ZapToMCP

ZapToMCP 是一個基於 Model Context Protocol (MCP) 的實現，支持多種傳輸方式。它是 FastMCP 和 LiteMCP 的改進版本，適用於對高性能和高擴展性有要求的場景。

🚀 快速開始

安裝

要開始使用，請先安裝 npm 包：

npm install @zaptomcp/sdk

示例

服務器端

const { Server } = require('@zaptomcp/sdk');

async function main() {
    const server = new Server({
        name: 'test-server',
        version: '1.0.0'
    });

    await server.start();
}

main().catch(console.error);

客戶端

const { Client } = require('@zaptomcp/sdk');

async function main() {
    const client = new Client({
        name: 'test-client',
        version: '1.0.0'
    });

    await client.connect(new HTTPClientTransport('http://localhost:3000'));
}

main().catch(console.error);

✨ 主要特性

• 多種傳輸協議：支持內存、SSE、標準 I/O 和流式 HTTP 等多種傳輸協議。
• 高性能處理：優化了資源管理和數據交換效率。
• 易於擴展：模塊化設計，便於添加新功能和傳輸方式。

📦 安裝指南

要開始使用，請先安裝 npm 包：

npm install @zaptomcp/sdk

💻 使用示例

基礎用法

服務器端

const { Server } = require('@zaptomcp/sdk');

async function main() {
    const server = new Server({
        name: 'test-server',
        version: '1.0.0'
    });

    await server.start();
}

main().catch(console.error);

客戶端

const { Client } = require('@zaptomcp/sdk');

async function main() {
    const client = new Client({
        name: 'test-client',
        version: '1.0.0'
    });

    await client.connect(new HTTPClientTransport('http://localhost:3000'));
}

main().catch(console.error);

📚 詳細文檔

倉庫結構

項目包含以下幾個主要部分：

• packages/sdk：核心的 MCP SDK，提供服務器和客戶端實現。
• examples：展示如何使用 SDK 的示例代碼。
• docs：項目的文檔資料。
• scripts：用於項目構建、測試和其他開發任務的腳本。

開發腳本

項目提供了以下 npm 腳本：

• dev：在開發模式下運行 SDK。
• build：構建 SDK 包。
• test：運行測試用例。

例如，在 SDK 目錄下執行：

cd packages/sdk && npm run dev

SDK 包詳細信息

功能概述

SDK 提供以下主要功能：

• Server 類：用於創建和管理 MCP 服務器。
• 多種傳輸實現：
  • InMemoryTransport：內存中的傳輸方式，適合測試環境。
  • SSETransport：基於 Server-Sent Events 的即時通信。
  • StdIOTransport：使用標準輸入輸出的控制檯模式。
  • StreamableHTTPTransport：支持流式數據傳輸的 HTTP 協議實現。

安裝和開發

要在 SDK 包上進行開發，請執行以下步驟：

cd packages/sdk
npm install
npm run dev

測試

運行測試用例：

cd packages/sdk
npm test

貢獻指南

歡迎任何貢獻！請按照以下步驟提交 Pull Request：

1. 叉倉庫。
2. 創建功能分支（例如：feature/amazing-feature）。
3. 使用 conventional commits 提交更改（使用 npm run commit）。
4. 推送到分支。
5. 打開 Pull Request。

🔧 技術細節

項目採用以下工具確保代碼質量：

• TypeScript：提供靜態類型檢查。
• ESLint 和 Prettier：保證代碼風格一致。

📄 許可證

此項目採用 MIT 許可證，具體內容見 LICENSE 文件。

致謝

• ZapToMCP 受 FastMCP 的啟發。
• 該項目實現了 Model Context Protocol 的開源標準 TypeScript SDK。
• FastMCP 受 Jonathan Lowin 的 Python 實現 fastmcp 啟發。
• 部分代碼實現借鑑了 LiteMCP。
• 部分代碼實現參考了 Model Context 協議中的 SSE 實現。

⚠️ 重要提示

此倉庫正在積極開發中。API 和實現細節可能會發生變化。使用請自行承擔風險。