Higress Ops MCP Server

🚀 Higress OPS MCP 服務器

Higress OPS MCP 服務器是一個實現模型上下文協議（MCP）的服務器，可用於對Higress進行全面配置和管理。此倉庫還提供了一個基於LangGraph和LangChain MCP 適配器構建的 MCP 客戶端，通過設計良好的代理流程架構實現與 Higress MCP 服務器的交互。

🚀 快速開始

配置環境變量

將 .env.example 文件複製到 .env 並填寫相應的值。

啟動 MCP 客戶端和 MCP 服務器

在標準輸入輸出模式下，MCP 服務器進程由 MCP 客戶端程序啟動。運行以下命令以啟動 MCP 客戶端和 MCP 服務器：

uv run client.py

✨ 主要特性

• 實現模型上下文協議（MCP），可對 Higress 進行全面配置和管理。
• 提供基於 LangGraph 和 LangChain MCP 適配器構建的 MCP 客戶端，通過代理流程架構實現與 Higress MCP 服務器的交互。

📦 安裝指南

本部分文檔未提供具體安裝步驟，若有相關需求請根據實際情況補充。

💻 使用示例

基礎用法

添加新工具

步驟 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"  # 在這裡添加你的工具函數
]

📚 詳細文檔

演示

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

🔧 技術細節

本部分文檔未提供具體技術細節，若有相關需求請根據實際情況補充。

📄 許可證

本部分文檔未提供許可證信息，若有相關需求請根據實際情況補充。