Skip to content

mcp_server.md

Latest commit

 

History

History
89 lines (65 loc) · 4.37 KB

mcp_server.md

File metadata and controls

89 lines (65 loc) · 4.37 KB

NetApp DataOps Toolkit MCP Server for ONTAP

The NetApp DataOps Toolkit MCP Server for ONTAP is an open-source server component written in Python that provides access to Traditional DataOps Toolkit capabilities through the Model Context Protocol (MCP). The server provides a set of tools for managing NetApp ONTAP storage systems, including volume creation, cloning, snapshot management, and SnapMirror relationships.

Note

This MCP server uses the stdio transport, as shown in the MCP Server Quickstart, making it a "local MCP server".

Tools

  • Create Volume: Rapidly provision new data volumes with customizable configurations.
  • Clone Volume: Create near-instantaneous, space-efficient clones of existing volumes using NetApp FlexClone technology.
  • List Volumes: Retrieve a list of all existing data volumes, with optional space usage details.
  • Mount Volume: Mount existing data volumes locally as read-only or read-write.
  • Create Snapshot: Create space-efficient, read-only copies of data volumes for versioning and traceability.
  • List Snapshots: Retrieve a list of all snapshots for a specific volume.
  • Create Qtree: Create new qtrees within volumes for flexible data organization.
  • List Qtrees: Retrieve a list of all qtrees in a volume or across all volumes in an SVM.
  • Get Qtree: Retrieve detailed information about a specific qtree.
  • Get Qtree Metrics: Retrieve historical performance metrics for a specific qtree.
  • Create SnapMirror Relationship: Set up SnapMirror relationships for efficient data replication.
  • List SnapMirror Relationships: Retrieve a list of all SnapMirror relationships on the storage system.
  • Create FlexCache Volume: Create FlexCache volumes for efficient data access and caching.
  • List FlexCache Volumes: Retrieve a list of all FlexCache volumes with their origin information.
  • Get FlexCache Origin: Retrieve detailed origin information for a specific FlexCache volume.
  • Update FlexCache Volume: Update configuration and properties of existing FlexCache volumes.
  • Create CIFS Share: Create a new CIFS share on a specified SVM with optional ACLs and properties.
  • List CIFS Shares: Retrieve a list of all existing CIFS shares, with optional filtering by SVM and name pattern.
  • Get CIFS Share: Retrieve detailed information about a specific CIFS share.

Prerequisites

  • Python >= 3.8
  • uv or pip

Usage Instructions

Run with uv (recommended)

To run the MCP server using uv, run the following command. You do not need to install the NetApp DataOps Toolkit package before running this command.

uvx --from netapp-dataops-traditional netapp_dataops_ontap_mcp.py

Install with pip and run from PATH

To install the NetApp DataOps Toolkit for Traditional Environments, run the following command.

python3 -m pip install netapp-dataops-traditional

After installation, the netapp_dataops_ontap_mcp.py command will be available in your PATH for direct usage.

Usage

DataOps Toolkit Config File

A DataOps Toolkit config file must be created before the MCP server can be used to perform data management operations. For more details, click here.

If you do not have a config file, you can run the following command to create one.

uvx --from netapp-dataops-traditional netapp_dataops_cli.py config
Example JSON Config

To use the MCP server with an MCP client, you need to configure the client to use the server. For many clients (such as VS Code, Claude Desktop, and AnythingLLM), this requires editing a config file that is in JSON format. Below is an example. Refer to the documentation for your MCP client for specific formatting details.

{
  "mcpServers": {
    "netapp_dataops_ontap_mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "netapp-dataops-traditional",
        "netapp_dataops_ontap_mcp.py"
      ]
    }
  }
}

Support

Report any issues via GitHub: https://github.com/NetApp/netapp-dataops-toolkit/issues.