Cisco NSO

Provides NSO data and operations to MCP clients, enabling AI-powered automation and tool-based interactions.

python

3

GitHub Stars

python

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "dbono711-cisco-nso-mcp-server": {
      "command": "cisco-nso-mcp-server",
      "args": [
        "--nso-scheme=http",
        "--nso-address=127.0.0.1",
        "--nso-port=8080",
        "--nso-username=admin",
        "--nso-password=admin"
      ],
      "env": {
        "LOG_FILE": "Path to log file (optional)"
      }
    }
  }
}

You can connect to the Cisco NSO MCP Server to access NSO data and operations through a set of MCP tools and resources. This server exposes NSO information and actions in a structured, tool-oriented way, enabling AI-powered automation via MCP clients.

How to use

Launch the MCP server to enable interaction with Cisco NSO data and operations through MCP tools. Use an MCP client to discover available tools, execute actions, and pass contextual information between steps. Typical usage flows include listing NED IDs and device groups, fetching device configurations or states, syncing from devices, and querying service types and services. You can combine multiple tool calls into a cohesive automation plan, and rely on the server’s structured responses to drive further steps in your automation.

How to install

Prerequisites: you need Python 3.12 or newer and access to a Cisco NSO RESTCONF API instance. Ensure the NSO instance is reachable from the machine where you run the MCP server.

Install the MCP server package with Python’s package manager.

pip install cisco-nso-mcp-server

# Verify installation by listing the available command (adjust as needed for your environment)
which cisco-nso-mcp-server || echo 'Command not found; ensure your PATH includes the installed package.'

Additional sections

Configuration is done through command-line parameters and environment variables. You can specify how to connect to NSO, where the MCP server should listen, and how logging is handled.

Available tools

get_device_ned_ids

Retrieves Network Element Driver (NED) IDs from Cisco NSO and returns a dictionary containing the list of NED IDs.

get_device_groups

Retrieves device groups from Cisco NSO and returns a dictionary containing the list of device groups.

get_device_platform

Gets platform information for a specific device in Cisco NSO. Requires a device name and returns platform details.

get_device_config

Obtains the full configuration for a specific device in Cisco NSO and returns the device configuration data.

get_device_state

Fetches the current state of a specific device in Cisco NSO and returns state information.

check_device_sync

Checks sync status for a specific device in Cisco NSO and returns the sync status.

sync_from_device

Synchronizes data from a specific device in Cisco NSO and returns the result of the sync operation.

get_service_types

Retrieves available service types in Cisco NSO and returns a dictionary with service type information.

get_services

Gets services for a specific service type in Cisco NSO and returns the list of services for that type.