MCP Test Client

MCP 测试客户端

用于测试 Model Context Protocol（MCP）服务的测试工具。该客户端提供了一个简洁的界面，可用于调用工具并验证响应，从而帮助你测试 MCP 服务实现。

功能

• 易于使用的 MCP 服务测试界面
• 内置工具列表查询和工具调用支持
• 使用 TypeScript 实现，类型安全
• 用于验证服务响应的断言工具
• 用于示例的模拟计算器服务实现

安装

bun install mcp-test-client

用法

基础示例

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

describe('MCP Server Tests', () => {
  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('should list available tools', async () => {
    const tools = await client.listTools();
    expect(tools).toContainEqual(
      expect.objectContaining({
        name: 'your-tool-name',
        description: 'Your tool description',
      })
    );
  });

  test('should call a tool', async () => {
    await client.assertToolCall(
      'your-tool-name',
      { arg1: 'value1', arg2: 'value2' },
      (result) => {
        expect(result.content[0].text).toBe('expected result');
      }
    );
  });
});

计算器服务示例

该软件包包含一个模拟计算器服务，用于测试和学习：

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

describe('Calculator Server Tests', () => {
  let client: MCPTestClient;

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

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

  test('should perform addition', 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

贡献

1. Fork 仓库
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 创建 Pull Request