ONOS MCP Server 🚀

ONOS MCP Server is a powerful bridge between the Model Context Protocol (MCP) and the Open Network Operating System (ONOS). It enables AI models to interact directly with your SDN (Software-Defined Networking) infrastructure, allowing for intelligent network management, monitoring, and automation.

✨ Features

• 📱 Application Management: List, inspect, activate, and deactivate ONOS applications.
• 🔌 Device Inventory: Detailed views of switches, routers, and other network entities.
• 🏠 Host Discovery: Track end-nodes, their locations, and IP/MAC associations.
• 🌊 Flow Control: Full visibility and control over network flows (list, filter by device, and add new flows).
• 🛠️ Seamless Integration: Built with Spring Boot and Spring AI MCP for robust, production-ready performance.

📋 Prerequisites

• Java 21 or higher.
• Maven 3.9+ (or use the included ./mvnw).
• A running instance of ONOS Controller (v2.x or higher recommended).

⚙️ Configuration

The server connects to ONOS via its REST API. You can configure the connection details in src/main/resources/application.yaml or via environment variables.

onos:
    controller:
        host: ${ONOS_CONTROLLER_HOST:http://localhost:8181}
        username: ${ONOS_CONTROLLER_USERNAME:onos}
        password: ${ONOS_CONTROLLER_PASSWORD:rocks}

Environment Variables

🚀 Getting Started

1. Build the project

./mvnw clean install

2. Run the server

./mvnw spring-boot:run

🔌 Connecting to MCP Clients

To use this server with an MCP client (such as Claude Desktop or Antigravity), add the following configuration to your mcp_config.json (or equivalent configuration file):

{
  "mcpServers": {
    "onos-mcp-server": {
      "command": "java",
      "args": [
        "-jar",
        "/path/to/onos-mcp-server.jar"
      ],
      "env": {
        "ONOS_CONTROLLER_HOST": "http://localhost:8181",
        "ONOS_CONTROLLER_USERNAME": "onos",
        "ONOS_CONTROLLER_PASSWORD": "rocks"
      }
    }
  }
}

[!NOTE] Make sure to build the project first with ./mvnw clean install to generate the JAR file in the target/ directory.

🛠️ Available MCP Tools

The server exposes several tools to the AI model:

Applications

• list-applications: List all installed applications and their status.
• get-application: Get details about a specific application.
• activate-application: Activate a specific application by name.
• deactivate-application: Deactivate a specific application.

Devices

• list-devices: Get a list of all devices (switches, routers).
• get-device: Get detailed info on a specific device.

Hosts

• list-hosts: List all discovered end-node hosts.
• get-host: Get details on a specific host.

Flows

• list-flows: List all network flows.
• list-device-flows: List flows for a specific device.
• add-flow: Push a new flow rule to a device.

🏗️ Tech Stack

• Core: Java 21, Spring Boot 3.5.9
• AI/MCP: Spring AI Starter MCP Server
• REST Client: Spring Cloud OpenFeign
• Utilities: Lombok

Created with ❤️ by ortegakb