mcp-server-ntopng

mcp-server-ntopng

NTOPNG Model Context Protocol 服务

一个适用于 NTOPNG 的 Model Context Protocol 服务实现，可让 AI Agent 使用 NTOPNG 数据库查询网络监控数据。

此 MCP 服务假定 ntopng 使用 ClickHouse 存储历史流量和告警。查看 ntopng Clickhouse

工具

• fetch_ntopng_all_ifids

• 获取 ntopng 中所有可用的接口 ID。

• get_ntopng_hosts_location

• 获取主机的地理位置和其他信息。

• fetch_ntopng_top_local_talkers

• 获取指定接口中排名前 10 的本地通信方。

• fetch_ntopng_top_remote_talkers

• 获取指定接口中排名前 10 的远程通信方。

• get_ntopng_all_alert_stats

• 获取所有告警的统计信息。

• get_ntopng_flow_alert_stats

• 获取流量告警的统计信息。

• get_ntopng_host_alert_stats

• 获取主机告警的统计信息。

• get_ntopng_interface_alert_stats

• 获取接口告警的统计信息。

• get_ntopng_mac_alert_stats

• 获取 MAC 告警的统计信息。

• get_ntopng_network_alert_stats

• 获取网络告警的统计信息。

• get_ntopng_snmp_device_alert_list

• 获取 SNMP 设备告警列表。

• get_ntopng_snmp_device_alert_stats

• 获取 SNMP 设备告警的统计信息。

• get_ntopng_system_alert_stats

• 获取系统告警的统计信息。

• query_ntopng_flows_data

• 从 ntopng 流量数据库中获取详细的流量数据。

• get_ntopng_top-k_flows

• 从 ntopng 流量数据库中获取排名前 k 的流量数据。

• get_ntopng_user_alert_stats

• 获取用户告警的统计信息。

• get_ntopng_flow_devices_stats

• 获取所有流量设备的统计信息。

• get_ntopng_sflow_devices_stats

• 获取所有 sFlow 设备的统计信息。

• list_tables_ntopng_database

• 列出 ntopng 数据库的表结构。

• query_ntopng_database

• 查询 ntopng Clickhouse 数据库。

状态

可与 Claude Desktop 应用以及其他符合 MCP 规范的主机和客户端配合使用。

目前尚不支持 MCP 资源或提示词。

配置

1. 创建或编辑位于以下位置的 Claude Desktop 配置文件：

   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%/Claude/claude_desktop_config.json

2. 添加以下内容：

{
  "mcpServers": {
    "mcp-ntopng": {
      "command": "/path/to/your/uv-binary",
      "args": ["run", "--with", "mcp-ntopng", "--python", "3.13", "mcp-ntopng"]
      "env": {
        "NTOPNG_HOST": "<ntopng-host>",
        "NTOPNG_DBPORT": "<ntopng-dbport>",
        "NTOPNG_DBUSER": "<ntopng-dbuser>",
        "NTOPNG_DBPASSWORD": "<ntopng-dbpassword>",
        "NTOPNG_SECURE": "true",
        "NTOPNG_VERIFY": "true",
        "NTOPNG_CONNECT_TIMEOUT": "30",
        "NTOPNG_SEND_RECEIVE_TIMEOUT": "300",
        "NTOPNG_API_KEY": "NTOPNG_TOKEN"
      }
    }
  }
}

3. 将 /path/to/your/uv-binary 替换为 uv 可执行文件的绝对路径。使用 which uv 查找路径。这样可确保启动服务时使用正确版本的 uv。

4. 重启 Claude Desktop 以应用更改。

开发

1. 在 claude_desktop_config.json 文件中设置环境变量，或在仓库根目录下的 .env 文件中设置。

NTOPNG_HOST=localhost
NTOPNG_PORT=9000
NTOPNG_USER=default
NTOPNG_PASSWORD=

3. 运行 uv sync 安装依赖项。按照此处的说明安装 uv。然后运行 source .venv/bin/activate。

4. 在项目主目录下运行 uv pip install -e . 安装 mcp-ntopng 包。

5. 为了方便测试，可以运行 mcp dev mcp_ntopng/mcp_server.py 来启动 MCP 服务。替换为合适的聊天客户端

环境变量

以下环境变量用于配置数据库连接：

• NTOPNG_HOST：ntopng 服务的主机名
• NTOPNG_DBUSER：Clickhouse DB 身份验证的用户名
• NTOPNG_DBPASSWORD：Clickhouse DB 身份验证的密码
• NTOPNG_API_KEY：ntopng 身份验证令牌。

可选

• NTOPNG_DBPORT：ntopng 服务中 Clickhouse DB 的端口号
  • 默认值：启用 HTTPS 时为 9000，禁用时为 8123
  • 通常无需设置，除非使用非标准端口
• NTOPNG_SECURE：启用／禁用 TLS 连接
  • 默认值：false
  • 设置为 true 可启用安全的 TLS 连接
• NTOPNG_VERIFY：启用／禁用 SSL 证书验证
  • 默认值：true
  • 设置为 `false to disable certificate verification (not recommended for production)
• NTOPNG_CONNECT_TIMEOUT：连接超时时间（秒）
  • 默认值：`30
  • 如果遇到连接超时，请增大此值
• NTOPNG_SEND_RECEIVE_TIMEOUT：发送／接收超时时间（秒）
  • 默认值：300
  • 对于长时间运行的查询，请增大此值

有关如何设置到 Clickhouse 的 TLS 连接，请参阅 ntopng 文档中的 TLS 设置。

开发

在本地计算机上安装此软件包：

$ uv sync
$ uv pip install -e .

运行 MCP Inspector

$ cd mcp_ntopng
$ source .env
$ CLIENT_PORT=8077 SERVER_PORT=8078  mcp dev run_mcp_ntopng.py --with clickhouse-driver --with python-dotenv --with uvicorn --with pip-system-certs

在 Claude Desktop 中使用本地库。

查找： /Users/marco/Library/Application\ Support/Claude/claude_desktop_config.json

编辑 claude_desktop_config.json，修改本地路径：

{
    "mcpServers": {
      "mcp-ntopng": {
        "command": "/Users/marco/Development/claude/mcp-server-ntopng/.venv/bin/python",
        "args": [
           "/Users/marco/Development/claude/mcp-server-ntopng/run_mcp_ntopng.py"
        ],
        "env": {
          "NTOPNG_HOST": "marcoeg-nod004.ntoplink.com",
          "NTOPNG_DBPORT": "9000",
          "NTOPNG_DBUSER": "default",
          "NTOPNG_DBPASSWORD": "",
          "NTOPNG_SECURE": "false",
          "NTOPNG_VERIFY": "false",
          "NTOPNG_CONNECT_TIMEOUT": "30",
          "NTOPNG_SEND_RECEIVE_TIMEOUT": "300",
          "SELECT_QUERY_TIMEOUT_SECS": "30",
          "NTOPNG_API_KEY": "NTOPNG_TOKEN"
        }
      }
    }
  }