Hoverfly MCP Server

🚀 Hoverfly MCP Server

このプロジェクトは、Spring Boot をベースとした Model Context Protocol (MCP) サーバーです。Hoverfly を、Cursor、Claude Desktop、GitHub Copilot などのAIアシスタントや、MCPをサポートする他のアシスタント向けのプログラマブルなツールとして公開します。外部サービスが利用できない場合でも、開発やテストを続行できるように、サードパーティAPIの動的なモッキングを可能にします。

🚀 クイックスタート

このサーバーを利用することで、外部サービスのモッキングを行い、開発やテストをスムーズに進めることができます。以下に、インストール方法や設定方法を説明します。

📦 インストール

⚠️ 重要提示

以下の前提条件とビルド手順は、ソースからビルドする場合やコントリビュートする場合にのみ必要です。ほとんどのユーザーは、Dockerイメージを使用するだけで十分です。

前提条件

• Java 17
• Maven 3.6+

ビルドと実行

git clone <repository-url>
cd hoverfly-mcp-server
mvn clean package
java -jar target/hoverfly-mcp-server-<version>.jar

<version> を、実際にビルドしたJARファイルのバージョンに置き換えてください。

📚 ドキュメント

⚙️ MCPサーバーとしての設定 (Dockerを使用)

Model Context Protocol (MCP) をサポートするAIアシスタントでこのサーバーを使用するには、.mcp.json または mcp.config.json に以下を追加します。

{
  "mcpServers": {
    "hoverfly-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-p 8500:8500",
        "-p 8888:8888",
        "-v /path/to/your/data:/opt/hoverfly-mcp/simulation-data",
        "docker.io/kapish88/hoverfly-mcp-server"
      ]
    }
  }
}

• 8500: Hoverflyのプロキシポート (モックサービス)
• 8888: Hoverflyの管理ポート (モック制御API)
• -v /path/to/your/data:/opt/hoverfly-mcp/simulation-data: シミュレーションデータを永続化するためのボリュームをマウント

Dockerがインストールされていることを確認してください。ローカルにイメージがない場合は、自動的に取得されます。

🔧 公開されているMCPツール

これらのツールは、AIアシスタントがAIアシスタントホストを介してプログラムで呼び出すことができます。

💾 シミュレーションの永続化

サーバーは、固定のマウントボリュームを介してシミュレーションの永続化をサポートしています。

起動時の自動ロード

start_hoverfly_web_server でHoverflyを起動すると、サーバーはデフォルトで以下の操作を行います。

• /opt/hoverfly-mcp/simulation-data から最新のシミュレーションファイルを読み込みます (存在する場合)。
• シミュレーションファイルが見つからない場合は、クリーンな状態で起動します。

適切なパラメータを設定することで、自動ロードを無効にすることができます。

永続的なデータとボリュームのマウント

シミュレーションデータを再起動間で保持するには、ホストディレクトリをコンテナ内の /opt/hoverfly-mcp/simulation-data にマウントする必要があります。
これは、永続的なデータを保存するためにサポートされている唯一の場所です。

⚠️ 重要提示

ホストディレクトリは、コンテナユーザーが書き込み可能である必要があります。

シミュレーションファイルは、ダウンロードツールを明示的に呼び出した場合にのみ、このディレクトリに保存されます。

🤝 コントリビュート

1. このリポジトリをフォークします。
2. 機能ブランチを作成します。
3. プルリクエストを送信します。

📄 ライセンス

ライセンス条項については、LICENSE ファイルを参照してください。