Onos MCP Server

An MCP service implementation based on the ONOS controller, providing network control and management capabilities

Developer tools Home automation and IoT #SDN Control #Network Management #AI Assistance #ONOS Integration .Python

rating : 2.5 points

downloads : 7.7K

update time : 2025-04-29

Open Site

What is the ONOS MCP Server?

The ONOS MCP Server is a service platform that provides network management and control capabilities through the ONOS controller. It allows users to access functions such as network device information, topology details, traffic statistics, and application management, and is particularly suitable for education, research, and network operation and maintenance scenarios.

How to use the ONOS MCP Server?

Users can start the server by configuring environment variables and running commands, and utilize its API interfaces for network monitoring, configuration, and optimization.

Applicable Scenarios

The ONOS MCP Server is suitable for scenarios that require centralized network management, automated operation and maintenance, and AI-assisted decision-making, such as university laboratories, enterprise network centers, and SDN experimental platforms.

Main Features

Network Resource Management

Access device, link, host, and topology information provided by the ONOS API.

Network Analysis Tools

Provide functions such as performance monitoring, traffic pattern analysis, and resource utilization statistics.

Application Management

Install, activate, deactivate, and uninstall ONOS applications.

Path Computation

Find the optimal path to connect network nodes according to requirements.

Advantages

Support multiple network protocols and device types

Integrate AI-assisted network management functions

Open API for easy secondary development

Limitations

High hardware dependency, requiring high-performance server support

Steep learning curve, suitable for users with a certain technical background

How to Use the ONOS MCP Server

Install Dependencies

Ensure that Python 3.7+ and the uv tool and httpx library are installed.

Configure Environment Variables

Set the base URL, username, and password of the ONOS API.

Start the Server

Run the server script to start the service.

Usage Examples

Diagnose Network Connectivity

When encountering network failures, this function can be used to quickly locate the root cause of the problem.

Optimize Traffic Paths

Adjust network routing to improve overall efficiency by analyzing historical traffic data.

Frequently Asked Questions

How to view the status of the ONOS MCP Server?

Does it support custom traffic rules?

Related Resources

ONOS Official Documentation

Gain in-depth understanding of the working principles and API interfaces of ONOS.

GitHub Project Repository

Get the latest version of the code and participate in community contributions.

🚀 ONOS MCP Server

A server implementation based on the Model Context Protocol (MCP) that provides network control and management functions through the ONOS SDN controller. This server enables AI assistants to access ONOS network management, OpenFlow device control, and comprehensive analysis tools via structured API interfaces. It is suitable for educational environments, network operations, SDN research, and AI-assisted network management.

🚀 Quick Start

The ONOS MCP Server is a powerful tool that allows AI assistants to interact with the ONOS SDN controller. It provides a structured API interface to access network management, device control, and analysis tools.

✨ Features

Network Resources

The server provides access to ONOS REST API endpoints, including:

Network devices, links, and hosts
Topology information
Flow rules and intents
Applications and services
Statistics and metrics
System and cluster health status

Analytical Tools

Network Overview: Obtain a comprehensive view of devices, links, hosts, and clusters, including detailed device information.
Network Analysis: Analyze performance metrics, traffic patterns, and utilization statistics.
System Health: Monitor memory usage, cluster status, and component health.
Application Management: Install, activate, deactivate, and uninstall ONOS applications.
Flow Configuration: Create and manage flow rules and intents.
Path Calculation: Find the optimal path between network endpoints.

Specialized Tips

Network Diagnosis: Troubleshoot connectivity issues and service degradation.
Intent-Based Configuration: Implement connection goals and policies.
Network Health Analysis: Generate comprehensive status reports.
QoS Configuration: Set traffic priorities and service levels.
Performance Optimization: Improve resource allocation and scalability.

📦 Installation

Configuration Requirements

Python 3.7+
uv for dependency management
A running ONOS controller
httpx library
mcp library

Configuration

Configure the server using environment variables:

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

💻 Usage Examples

Usage on Claude Desktop

{
  "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"
      }
    }
  }
}