MCP Server E2e Testing Example

🚀 MCP サーバー E2E テストのサンプル

このリポジトリは、Vitest を使用して、TypeScript MCP（モデルコンテキストプロトコル）サーバーのエンドツーエンド（E2E）テストを行う 2 つの方法を最小限の構成でデモンストレーションしています。

• オリジナルの方法：tsx を使って CLI を起動し、stdio を介して通信（JSON-RPC）を行います。
• SDK の方法：公式の MCP SDK の Client と InMemoryTransport を使って、メモリ内で RPC を行います。

リポジトリのURL：https://github.com/mkusaka/mcp-server-e2e-testing-example

🚀 クイックスタート

前提条件

• Node.js ≥ 16
• pnpm がグローバルにインストールされていること
• Git

インストール

# リポジトリをクローンする
git clone https://github.com/mkusaka/mcp-server-e2e-testing-example.git
cd mcp-server-e2e-testing-example

# 依存関係をインストールする
pnpm install

✨ 主な機能

このリポジトリでは、TypeScript MCP サーバーの E2E テストを 2 つの方法で行うことができます。

• オリジナルの方法では、tsx を使って CLI を起動し、stdio を介して通信（JSON-RPC）を行います。
• SDK の方法では、公式の MCP SDK の Client と InMemoryTransport を使って、メモリ内で RPC を行います。

📦 インストール

前提条件

• Node.js ≥ 16
• pnpm がグローバルにインストールされていること
• Git

手順

# リポジトリをクローンする
git clone https://github.com/mkusaka/mcp-server-e2e-testing-example.git
cd mcp-server-e2e-testing-example

# 依存関係をインストールする
pnpm install

💻 使用例

基本的な使用法

1. オリジナル（spawn + stdio）テスト

このテストセットでは、npx tsx を使って CLI (src/cli.ts) を起動し、stdin/stdout を介して JSON-RPC を送信します。

pnpm vitest run tests/e2e/raw.spec.ts

2. SDK（メモリ内）テスト

このテストセットでは、MCP SDK の Client + InMemoryTransport を使って、子プロセスを起動することなく同じサーバーロジックを呼び出します。

pnpm vitest run tests/e2e/sdk.spec.ts

高度な使用法

package.json に以下のスクリプトを追加することで、テストを簡単に実行できます。

{
  "scripts": {
    "test:raw": "vitest run tests/e2e/raw.spec.ts",
    "test:sdk": "vitest run tests/e2e/sdk.spec.ts",
    "test": "vitest run"
  }
}

• pnpm run test:raw - オリジナル/stdio テストのみを実行します。
• pnpm run test:sdk - メモリ内 SDK テストのみを実行します。
• pnpm run test - すべてのテストを実行します。

📚 ドキュメント

このリポジトリは、サンプル/テンプレートとして使用することを目的としています。以下のことができます。

• src/server.ts ファクトリを自分の MCP サーバーに適合させる。
• raw.spec.ts と sdk.spec.ts を拡張して、より多くのテストケースを含める。
• CI パイプラインに統合する。

📦 リポジトリ構成

.
├── LICENSE
├── README.md
├── package.json
├── pnpm-lock.yaml
├── src
│   ├── cli.ts         # CLI エントリポイント（tsx + stdio トランスポート）
│   └── server.ts      # createServer() ファクトリ（リソース、プロンプト、ツール）
├── tests
│   └── e2e
│       ├── raw.spec.ts  # spawn ベースの E2E テスト
│       └── sdk.spec.ts  # SDK/InMemoryTransport ベースの E2E テスト
└── tsconfig.json

📄 ライセンス

このリポジトリは MIT License の下で公開されています。