MCP Server Ntopng

🚀 mcp-server-ntopng

An NTOPNG Model Context Protocol server that enables AI models to interact through context.

This is an implementation of a Model Context Protocol server designed to interface with NTOPNG. The protocol allows AI models to interact through context.

✨ Features

• Support for Multiple Query Types: Including real-time data and historical data analysis.
• Efficient Communication Mechanism: Ensures efficient data exchange between the model and NTOPNG.
• Flexible Configuration Options: Supports custom environment variables to adjust server behavior.

🚀 Quick Start

Environment Variable Configuration

The following environment variables are used to configure the database connection:

• NTOPNG_HOST: Hostname of the NTOPNG service.
• NTOPNG_DBUSER: Authentication username for the ClickHouse database.
• NTOPNG_DBPASSWORD: Authentication password for the ClickHouse database.
• NTOPNG_API_KEY: Authentication token for NTOPNG.

Optional Configuration

• NTOPNG_DBPORT: Port number of the ClickHouse database. The default value depends on whether HTTPS is enabled (default is 9000 if HTTPS is enabled, 8123 if not).
• NTOPNG_SECURE: Enable/disable TLS connection. Default is false.
• NTOPNG_VERIFY: Enable/disable SSL certificate verification. Default is true.
• NTOPNG_CONNECT_TIMEOUT: Connection timeout in seconds. Default is 30 seconds.
• NTOPNG_SEND_RECEIVE_TIMEOUT: Send/receive timeout in seconds. Default is 300 seconds.

Installation and Execution

1. Install Dependencies:

   $ uv sync
   

2. Install the Package:

   $ uv pip install -e .
   

3. Start the Server (using example environment variables):

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

Usage in Claude Desktop

Edit the file at the path: /Users/marco/Library/Application\ Support/Claude/claude_desktop_config.json

Modify the claude_desktop_config.json file by replacing the local path with the following content:

{
    "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",
          "SELECT_QUERY_TIMEOUT_SECS": "30",
          "NTOPNG_API_KEY": "NTOPNG_TOKEN"
        }
      }
    }
  }

⚠️ Important Note

Please adjust the paths and values in the above configuration according to your actual situation.