MCP Server E2e Testing Example

🚀 MCP 服務器 E2E 測試示例

本項目是一個最小化的演示倉庫，展示了使用 Vitest 對 TypeScript MCP（模型上下文協議）服務器進行端到端（E2E）測試的兩種模式：

• 原始方法：通過 tsx 孵化 CLI 並通過 stdio 進行通信（JSON-RPC）。
• SDK 方法：使用官方 MCP SDK 的 Client 和 InMemoryTransport 進行內存中 RPC。

倉庫地址：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

📦 倉庫佈局

.
├── LICENSE
├── README.md
├── package.json
├── pnpm-lock.yaml
├── src
│   ├── cli.ts         # CLI 入口點（tsx + stdio 運輸）
│   └── server.ts      # createServer() 工廠（資源、提示、工具）
├── tests
│   └── e2e
│       ├── raw.spec.ts  # spawn-based E2E 測試
│       └── sdk.spec.ts  # SDK/InMemoryTransport-based E2E 測試
└── tsconfig.json

🧪 運行 E2E 測試

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 管道中

📄 許可證

以 MIT License 發佈。