🚀 MCP 测试客户端

MCP 测试客户端是一个专门用于测试 Model Context Protocol (MCP) 服务器的工具。它为用户提供了简洁的接口，可执行工具调用并验证服务器响应，助力用户对 MCP 服务器实现进行全面测试。

🚀 快速开始

MCP 测试客户端能帮助你轻松测试 MCP 服务器。你可以按照以下步骤进行操作：

1. 安装客户端。
2. 编写测试代码，使用客户端提供的方法进行工具调用和结果验证。

✨ 主要特性

• 易于使用的测试界面：专门针对 MCP 服务器设计，操作简单便捷。
• 内置工具支持：支持工具列表查看和工具调用功能。
• 类型安全：使用 TypeScript 实现，保障代码的类型安全。
• 断言工具：提供断言工具，方便验证服务器响应结果。
• 示例服务器：包含 mock 计算器服务器示例，便于测试和学习。

📦 安装指南

使用以下命令安装 MCP 测试客户端：

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 许可证。

💡 贡献指南

如果你想为该项目做出贡献，可以按照以下步骤进行：

1. Fork 该项目仓库。
2. 创建一个新的分支用于功能实现或问题修复。
3. 提交更改并推送到该分支。
4. 创建一个 Pull Request 到 upstream 主分支。

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