MCP Test Client

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

在提出拉取請求之前，請確保你的代碼通過所有現有測試，並且文檔和代碼風格保持一致。