Higress Ops MCP Server

🚀 Higress OPS MCP サーバー

このサーバーは、モデルコンテキストプロトコル（MCP）を実装しており、Higress の包括的な設定と管理を行います。また、このリポジトリには、LangGraph と LangChain MCP アダプター をベースに構築された MCP クライアントも提供されており、設計良好なプロキシフローアーキテクチャを通じて Higress MCP サーバーとのやり取りを実現します。

🎥 デモ

https://github.com/user-attachments/assets/bae66b77-a158-452e-9196-98060bac0df7

📦 インストール

環境変数の設定

.env.example ファイルを .env にコピーし、該当する値を記入してください。

MCP クライアントと MCP サーバーの起動

標準入出力モードでは、MCP サーバープロセスは MCP クライアントプログラムによって起動されます。以下のコマンドを実行して、MCP クライアントと MCP サーバーを起動します。

uv run client.py

💻 使用例

新しいツールの追加

ステップ 1：新しいツールクラスの作成または既存クラスの拡張

• 新しいツールカテゴリを追加する場合は、tools ディレクトリに新しいファイルを作成します。
• 既存のカテゴリに適合する場合は、既存のクラスにツールを追加します。

from typing import Dict, List, Any
from fastmcp import FastMCP

class YourTools:
    def register_tools(self, mcp: FastMCP):
        @mcp.tool()
        async def your_tool_function(arg1: str, arg2: int) -> List[Dict]:
            """
            あなたのツールの説明。
            
            Args:
                arg1: arg1 の説明
                arg2: arg2 の説明

            Returns:
                戻り値の説明
            
            Raises:
                ValueError: リクエストが失敗した場合
            """
            # self.higress_client を使用して API 呼び出しを実装します
            return self.higress_client.your_api_method(arg1, arg2)

ステップ 2：ツールが Higress コンソール API とやり取りする必要がある場合、HigressClient に新しいメソッドを追加する

• メソッドを utils/higress_client.py に追加して、API 呼び出しをラップします。
• 既存の HTTP メソッド（get、put、post）を使用して実際の API 通信を行います。

def your_api_method(self, arg1: str, arg2: int) -> List[Dict]:
    """
    この API メソッドの機能説明。
    
    Args:
        arg1: arg1 の説明
        arg2: arg2 の説明
        
    Returns:
        レスポンスデータ
        
    Raises:
        ValueError: リクエストが失敗した場合
    """
    path = "/v1/your/api/endpoint"
    data = {"arg1": arg1, "arg2": arg2}
    return self.put(path, data)  # または self.get(path) または self.post(path, data)

ステップ 3：サーバーでツールクラスを登録する

• ツールクラスを server.py の tool_classes リストに追加します。
• このリストは、ToolsRegister がすべてのツールをインスタンス化して登録するために使用されます。
• ToolsRegister は、自動的に logger と higress_client 属性を設定します。

tool_classes = [
    CommonTools,
    RequestBlockTools,
    RouteTools,
    ServiceSourceTools,
    YourTools  # ここにあなたのツールクラスを追加します
]

ステップ 4：ツールが人間の確認を必要とする場合、SENSITIVE_TOOLS に追加する

• このリストに含まれるツールは、実行前に人間の確認が必要です。

# 人間の確認が必要な書き込み操作を定義します
SENSITIVE_TOOLS = [
    "add_route", 
    "add_service_source",
    "update_route",
    "update_request_block_plugin", 
    "update_service_source",
    "your_tool_function"  # ここにあなたのツール関数を追加します
]