MCP Test Client

🚀 MCP テストクライアント

このツールは、Model Context Protocol (MCP) サーバーをテストするために使用されます。クライアントは、ツール呼び出しを実行し、応答を検証するためのシンプルなインターフェースを提供し、MCP サーバーの実装をテストするのに役立ちます。

✨ 主な機能

• MCP サーバー用の使いやすいテストインターフェース
• ツールリストとツール呼び出しの組み込みサポート
• TypeScript を使用した型安全な実装
• サーバー応答を検証するためのアサーションツールの提供
• テストと学習を容易にするためのモック計算機サーバーの実装例の提供

📦 インストール

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

高度な使用法

このパッケージには、テストと学習用のモック計算機サーバーが含まれています。

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

貢献ガイド

• このプロジェクトのリポジトリをフォークします。
• 新しいブランチを作成して、機能実装または修正を行います。
• 変更をコミットし、そのブランチにプッシュします。
• upstream のメインブランチに Pull Request を作成します。

プルリクエストを提出する前に、コードがすべての既存のテストに合格し、ドキュメントとコードスタイルが一致していることを確認してください。