mcp-testing-kit

mcp-testing-kit

用于测试 MCP 服务的测试库。

概述

mcp-testing-kit 提供用于测试 Model Context Protocol (MCP) 服务的工具。你可以使用它连接到 MCP 服务实例、发送请求、接收通知，并在测试中断言服务的行为。

功能

• 适用于任何测试框架（vitest、jest 等）
• 轻量，只提供测试 MCP 服务所需的实用工具。
• Typescript

安装

$ npm i -D mcp-testing-kit

示例

假设你在 example/basic/src/index.ts 中定义了一个 MCP 服务：

// mcp-server.ts
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { z } from "zod";

const server = new McpServer({ name: 'simple-mcp-server', version: '1.0.0' });

server.tool(
  'add',
  'Add two numbers MCP style',
  { 
    a: z.number().describe('first number'), 
    b: z.number().describe('second number') 
  },
  async ({ name }) => ({
    messages: [
      { role: 'user', content: { type: 'text', text: String(a + b) } }
    ]
  })
);

export default server;

你可以像这样使用 mcp-testing-kit 编写测试：

// mcp-server.test.js
import server from "../src/index.js";
// Use your favorite testing framework.
import { describe, it, expect, afterEach } from "vitest";
import { connect, close } from "../../../index.js";

describe("Basic MCP server", () => {
  afterEach(async () => {
    await close(server);
  });

  it("Should return correct sum when `sum` is called", async () => {
    // Connect to the server and create a mock client.
    const client = await connect(server);
    const result = await client.callTool("greeting-template", { a: 10, b: 2 });
    expect(result.content[0].text).toEqual("12");
  });
});

工作原理

• 创建一个虚拟传输层，直接连接到 MCP 服务，而不依赖 HTTP/SSE。
• 提供抽象方法，让你可以直接调用服务上的工具/资源/提示词。

API

connect(server: Server)

连接到 MCP 服务实例，并返回一个包含以下方法的客户端：

方法	签名	描述
listTools	(): Promise<ListToolsResult>	列出服务上注册的所有工具。
callTool	(tool: string, params?: any): Promise<any>	根据名称调用工具，并可选择传入参数。
listResources	(): Promise<ListResourcesResult>	列出服务上注册的所有资源。
listPrompts	(): Promise<ListPromptsResult>	列出服务上注册的所有提示词。
getPrompt	(prompt: string, params?: any): Promise<any>	根据名称获取提示词，并可选择传入参数。
onNotification	(cb: (message: JSONRPCMessage) => void): void	注册用于接收服务通知的回调。
onError	(cb: (message: JSONRPCMessage) => void): void	注册用于接收服务错误消息的回调。
onProgress	(cb: (message: JSONRPCMessage) => void): void	注册用于接收服务进度通知的回调。
sendToServer	(message: Request): Promise<any>	向服务发送原始 JSON-RPC 请求。

close(server: Server)

关闭 MCP 服务实例。

更多示例

查看 example/basic，了解功能完整的 MCP 服务及其对应测试。

许可证

MIT