Zaptomcp

🚀 ZapToMCP

ZapToMCP は、Model Context Protocol (MCP) をベースにした実装で、複数のトランスポート方式をサポートしています。FastMCP と LiteMCP の改良版で、高性能と高拡張性が必要なシーンに最適です。

⚠️ 重要提示

このリポジトリは現在積極的に開発中です。API と実装の詳細は変更される可能性があります。使用は自己責任でお願いします。

🚀 クイックスタート

ZapToMCP は、様々な環境で Model Context Protocol を実装するための柔軟で効率的なフレームワークを提供します。

✨ 主な機能

• 複数のトランスポートプロトコル：メモリ、SSE、標準 I/O、ストリーミング HTTP をサポート。
• 高性能処理：リソース管理とデータ交換効率を最適化。
• 拡張容易：モジュール化設計により、新機能やトランスポート方式の追加が簡単。

📦 インストール

SDK を使用するには、まず 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

コード品質

このプロジェクトでは、以下のツールを使用してコード品質を確保しています。

• TypeScript：静的型チェックを提供。
• ESLint と Prettier：コードスタイルの統一を保証。

🤝 貢献ガイド

貢献いただける場合は、以下の手順で Pull Request を送信してください。

1. リポジトリをフォークする。
2. 機能ブランチを作成する（例：feature/amazing-feature）。
3. conventional commits を使用して変更をコミットする（npm run commit を使用）。
4. ブランチにプッシュする。
5. Pull Request を開く。

📄 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルを参照してください。

🙏 謝辞

• ZapToMCP は FastMCP からインスピレーションを得ています。
• このプロジェクトは、Model Context Protocol のオープンソース標準 TypeScript SDK を実装しています。
• FastMCP は Jonathan Lowin の Python 実装 fastmcp からインスピレーションを得ています。
• 一部のコード実装は LiteMCP を参考にしています。
• 一部のコード実装は Model Context プロトコルの SSE 実装 を参考にしています。