Davidlin2k Onos MCP Server

🚀 ONOS MCP Server

An MCP (Model Context Protocol) server implemented based on the ONOS SDN controller, offering network control and management functions through ONOS's REST API, including OpenFlow device control and comprehensive analysis. This server is ideal for educational environments, network prototyping, and ONOS research.

🚀 Quick Start

Prerequisites

• Python 3.7+
• uv
• ONOS controller (running and accessible)
• httpx library
• mcp library

Configuration

The server uses the following environment variables:

• ONOS_API_BASE: The base URL of the ONOS API (default: http://localhost:8181/onos/v1)
• ONOS_USERNAME: The username for ONOS API authentication (default: onos)
• ONOS_PASSWORD: The password for ONOS API authentication (default: rocks)

Add the Server to Your Configuration

# Add the server to your claude_desktop_config.json file
{
  "mcpServers": {
    "onos": {
      "command": "uv",
      "args": [
        "--directory",
        "parent_of_servers_repo/servers/src/onos-mcp-server",
        "run",
        "server.py"
      ],
      "env": {
        "ONOS_API_BASE": "http://localhost:8181/onos/v1",
        "ONOS_USERNAME": "onos",
        "ONOS_PASSWORD": "rocks"
      }
    }
  }
}

✨ Features

Resources

The server exposes over 30 dynamic resources, including:

• onos://devices: Information about all network devices
• onos://device/{deviceId}: Detailed information about a specific device
• onos://links: Information about all network links
• onos://hosts: Information about all hosts connected to the network
• onos://topology: An overview of the current network topology
• onos://applications: Information about all installed applications
• onos://flows/{deviceId}: All flow entries for a specific device
• onos://system: High-level system information, including version and memory usage
• onos://metrics: Statistical information about all metrics
• onos://meters/{deviceId}: All rate limiter entries for a specific device
• onos://intents: All intents in the system
• onos://statistics/*: Statistical information about ports, flows, and rate limiters
• Other resources for device configuration, QoS management, and other diagnostic tasks

Prompts

The server provides the following interactive prompts:

• Network Management: View and manipulate the network topology through specific commands.
• Device Control: Configure and monitor devices, such as viewing port status.
• Traffic Analysis: Analyze network traffic and generate reports.
• QoS Management: Configure and set Quality of Service (QoS) to optimize network performance.
• Troubleshooting: Diagnose network problems, collect logs, and error information.

Tools

The server provides the following tools:

• Network Management Tools: For topology analysis, path calculation, and device monitoring.
• Application Management Tools: For installing, upgrading, and uninstalling applications.
• Configuration Tools: For detailed configuration of devices and services.
• Diagnostic Tools: For troubleshooting and performance optimization.

📄 License

This MCP server is released under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please refer to the LICENSE file in the project repository.

👥 Contribution

Contributions are welcome! Please feel free to submit pull requests, report bugs, or suggest new features.