MCP Test Client

🚀 MCP 测试客户端

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');
      }
    );
  });
});

📚 详细文档

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 主分支。

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