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 服务正在运行且可访问。