MCP Server for SuzieQ

MCP Server for SuzieQ

site icon
2025.04.10 2
Python网络可观测性网络监控其它
SuzieQ MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,旨在通过 REST API 与 SuzieQ 网络可观测性实例进行交互。该服务器将 SuzieQ 的命令暴露为 MCP 工具,使语言模型和其他 MCP 客户端能够查询网络状态表和获取聚合统计信息。
View on GitHub

Overview

基本能力

产品定位

SuzieQ MCP Server 是一个网络可观测性工具,通过 MCP 协议提供对 SuzieQ 实例的访问能力。

核心功能

  • run_suzieq_show: 访问 'show' 命令,查询详细的网络状态表。
  • run_suzieq_summarize: 访问 'summarize' 命令,获取聚合统计信息和摘要。

适用场景

  • 网络状态监控
  • 网络故障排查
  • 网络性能分析

工具列表

  • run_suzieq_show: 查询 SuzieQ 表数据,支持过滤。
  • run_suzieq_summarize: 对 SuzieQ 表数据进行汇总统计。

常见问题解答

  • 错误: "SuzieQ API endpoint or key not configured...": 确保 .env 文件位于 main.py 同一目录,且配置正确。
  • HTTP 错误 (4xx, 5xx): 检查 API 密钥和端点是否正确,确保 API 服务器正在运行。

使用教程

使用依赖

  • Python: 版本 3.8 或更高。
  • uv: 快速 Python 包安装器和解析器。
  • SuzieQ 实例: 运行中的 SuzieQ 实例,并启用 REST API。
  • SuzieQ API 端点和密钥: 需要 SuzieQ API 的 URL 和有效的 API 密钥。

安装教程

通过 Smithery 安装

npx -y @smithery/cli install @PovedaAqui/suzieq-mcp --client claude

手动安装

  1. 获取代码: 克隆仓库或下载 main.pyserver.py 文件。
  2. 创建虚拟环境: bash uv venv
  3. 激活环境:
  4. macOS/Linux: bash source .venv/bin/activate
  5. Windows: bash .venv\Scripts\activate
  6. 安装依赖: bash uv pip install mcp httpx python-dotenv

调试方式

直接运行

uv run python main.py

使用 MCP Inspector 调试

uv run mcp dev main.py

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。