MCP 测试客户端

一个用于测试 Model Context Protocol (MCP) 服务器的工具。此客户端为您提供了一个简单的接口来执行工具调用并验证响应，帮助您测试 MCP 服务器实现。

特性

• 针对 MCP 服务器的易于使用的测试界面
• 内置支持工具列表和工具调用
• 使用 TypeScript 实现类型安全
• 提供断言工具用于验证服务器响应
• 包含示例 mock 计算器服务器实现以便于测试和学习

安装

bun install mcp-test-client

使用方法

基本示例

import { MCPTestClient } from 'mcp-test-client';

describe('MCP 服务器测试', () => {
  let client: MCPTestClient;

  beforeAll(async () => {
    client = new MCPTestClient({
      serverCommand: 'bun',
      serverArgs: ['./path/to/your/server.ts'],
    });
    await client.init();
  });

  afterAll(async () => {
    await client.cleanup();
  });

  test('应列出可用工具', async () => {
    const tools = await client.listTools();
    expect(tools).toContainEqual(
      expect.objectContaining({
        name: 'your-tool-name',
        description: 'Your tool description',
      })
    );
  });

  test('应调用一个工具', async () => {
    await client.assertToolCall(
      'your-tool-name',
      { arg1: 'value1', arg2: 'value2' },
      (result) => {
        expect(result.content[0].text).toBe('expected result');
      }
    );
  });
});

计算器服务器示例

该包包含一个 mock 计算器服务器用于测试和学习：

import { MCPTestClient } from 'mcp-test-client';

describe('计算器服务器测试', () => {
  let client: MCPTestClient;

  beforeAll(async () => {
    client = new MCPTestClient({
      serverCommand: 'bun',
      serverArgs: ['./tests/mocks/calculator.ts'],
    });
    await client.init();
  });

  afterAll(async () => {
    await client.cleanup();
  });

  test('应执行加法', async () => {
    await client.assertToolCall(
      'calculate',
      { operation: 'add', a: 5, b: 3 },
      (result) => {
        expect(result.content[0].text).toBe('8');
      }
    );
  });
});

API 参考

MCPTestClient

构造函数

constructor(config: { serverCommand: string; serverArgs: string[] })

方法

• init(): Promise<void> - 初始化客户端并连接到服务器
• listTools(): Promise<Tool[]> - 获取服务器上的可用工具列表
• callTool(toolName: string, args: Record<string, unknown>): Promise<ToolResult> - 调用特定工具
• assertToolCall(toolName: string, args: Record<string, unknown>, assertion: (result: ToolResult) => void | Promise<void>): Promise<void> - 调用工具并在结果上运行断言
• cleanup(): Promise<void> - 清理资源并断开服务器连接

开发

先决条件

• Bun (v1.0.0 或更高版本)

设置步骤

1. 克隆仓库

git clone <repository-url>
cd mcp-test-client

2. 安装依赖项

bun install

3. 运行测试

bun test

许可证

MIT

贡献指南

• Fork 该项目仓库。
• 创建一个新的分支用于您的功能实现或修复。
• 提交您的更改并推送至该分支。
• 创建一个 Pull Request 到 upstream 主分支。

在提出拉取请求之前，请确保您的代码通过所有现有测试，并且文档和代码风格保持一致。