MCP Server E2E Testing Example

MCP 服务 E2E 测试示例

这是一个最小示例仓库，展示了如何使用 Vitest 对 TypeScript MCP（Model Context Protocol）服务进行端到端（E2E）测试的两种模式：

• 原始方式：使用 tsx 启动 CLI，并通过 stdio（JSON-RPC）通信。
• SDK 方式：使用官方 MCP SDK 的 Client 和 InMemoryTransport 进行内存 RPC。

仓库：https://github.com/mkusaka/mcp-server-e2e-testing-example

---

📁 仓库结构

.
├── LICENSE
├── README.md
├── package.json
├── pnpm-lock.yaml
├── src
│   ├── cli.ts         # CLI entrypoint (tsx + stdio transport)
│   └── server.ts      # createServer() factory (resources, prompts, tools)
├── tests
│   └── e2e
│       ├── raw.spec.ts  # spawn‑based E2E tests
│       └── sdk.spec.ts  # SDK/InMemoryTransport‑based E2E tests
└── tsconfig.json

---

🚀 开始使用

前置条件

• Node.js ≥ 16
• 全局安装 pnpm
• Git

安装

# Clone the repo
git clone https://github.com/mkusaka/mcp-server-e2e-testing-example.git
cd mcp-server-e2e-testing-example

# Install dependencies
pnpm install

---

🧪 运行 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 – 运行所有测试

---

📦 发布与使用

此仓库旨在作为示例/模板。你可以：

• 根据自己的 MCP 服务调整 src/server.ts 工厂函数
• 在 raw.spec.ts 和 sdk.spec.ts 中添加更多测试用例
• 集成到 CI 流水线中

---

📄 许可证

基于 MIT License 发布。