Suzieq MCP

🚀 MCP 服務器指南（基於 SuzieQ 的實現）

本指南詳細介紹了基於 SuzieQ 實現的 MCP 服務器的安裝、配置、啟動、使用方法以及故障排除，幫助你快速搭建和使用該服務器。

🚀 快速開始

要使用基於 SuzieQ 的 MCP 服務器，你需要完成安裝依賴項、配置環境和啟動服務等步驟。以下是詳細的操作指南。

📦 安裝指南

安裝依賴項

• Python 3.x：確保你的系統已經安裝了 Python 3.x 版本。
• uv 後臺運行工具：如果你沒有安裝 uv，可以使用其他後臺運行工具。

配置步驟

1. 下載並解壓代碼倉庫。
2. 在項目根目錄下創建一個 .env 文件，並添加以下內容：

   SUZIEQ_API_ENDPOINT=your_api_endpoint
   SUZIEQ_API_KEY=your_api_key
   

   請將 your_api_endpoint 和 your_api_key 替換為實際的 API 端點和密鑰。

💻 使用示例

服務啟動

啟動命令

uv run python main.py

參數說明

• --env-file：指定 .env 文件路徑（可選，默認為當前目錄）。

工具使用

run_suzieq_show

def run_suzieq_show(table: str, filters: Optional[Dict[str, Any]] = None) -> str:
    """
    查詢 SuzieQ 數據庫中的指定表。
    
    參數:
        table (str): 表名（例如 "device", "interface", "bgp"）。
        filters (Optional[Dict[str, Any]]): 過濾條件（可選，默認為空）。
        
    返回:
        str: 查詢結果的 JSON 格式字符串，或錯誤信息。
    """

run_suzieq_summarize

def run_suzieq_summarize(table: str, filters: Optional[Dict[str, Any]] = None) -> str:
    """
    總結 SuzieQ 數據庫中的指定表。
    
    參數:
        table (str): 表名（例如 "device", "interface", "bgp"）。
        filters (Optional[Dict[str, Any]]): 過濾條件（可選，默認為空）。
        
    返回:
        str: 總結結果的 JSON 格式字符串，或錯誤信息。
    """

示例用法

run_suzieq_show 示例

{
  "table": "device"
}

返回所有設備信息。

{
  "table": "bgp",
  "filters": { "hostname": "spine01" }
}

返回 hostname 為 spine01 的 BGP 鄰居信息。

run_suzieq_summarize 示例

{
  "table": "interface",
  "filters": { "vrf": "default", "state": "up" }
}

返回 VRF 為 default 且狀態為 up 的接口信息。

🛠️ 故障排除

錯誤：SuzieQ API 端點或密鑰未配置

• 確保 .env 文件位於項目根目錄。
• 檢查 SUZIEQ_API_ENDPOINT 和 SUZIEQ_API_KEY 是否正確配置。

其他錯誤

• 查看日誌文件以獲取更多錯誤信息。
• 確保 API 服務正在運行且可訪問。