Tools¶
The following tools are provided by the ONTAP MCP server.
ONTAP MCP provides a set of tools that can be used to interact with the ONTAP API. These tools are designed to help users discover and manage their ONTAP clusters more efficiently. The tools are categorized based on their functionality, such as API discovery, volume management, data protection, CIFS/SMB integration, NFS export policy management, performance management, SVM management, qtree management, network interface management, LUN and igroup management, iSCSI management, FCP management, NVMe management, and multi-cluster management.
All ONTAP MCP tools are annotated with hint metadata: readOnlyHint, idempotentHint, and destructiveHint. The readOnlyHint indicates that the tool does not modify any data and is safe to use for discovery and information retrieval. The destructiveHint indicates that the tool performs actions that can modify or delete data, and should be used with caution.
If you want to run the ONTAP MCP server in read-only mode, you can start the server with the --read-only flag. In this mode, only tools with the readOnlyHint will be available for use, ensuring that no modifications can be made to the ONTAP cluster.
To run without mcp-session-id header validation (e.g. behind proxies that strip session headers), use the --stateless flag. See the configuration documentation for more details.
API Discovery¶
list_ontap_endpoints(available when the API catalog is loaded)search_ontap_endpoints(available when the API catalog is loaded)describe_ontap_endpoint(available when the API catalog is loaded)ontap_get
Volume Management¶
create_volumeupdate_volumedelete_volume
Data Protection¶
create_snapshotdelete_snapshotrestore_snapshotcreate_snapshot_policyupdate_snapshot_policydelete_snapshot_policycreate_scheduleadd_schedule_in_snapshot_policyupdate_schedule_in_snapshot_policyremove_schedule_in_snapshot_policy
CIFS/SMB Integration¶
create_cifs_shareupdate_cifs_sharedelete_cifs_share
NFS Export Policy Management¶
create_nfs_export_policiesupdate_nfs_export_policiesdelete_nfs_export_policiescreate_nfs_export_policies_rulesupdate_nfs_export_policies_rulesdelete_nfs_export_policies_rules
Performance Management¶
list_qos_policiescreate_qos_policyupdate_qos_policydelete_qos_policy
Snapmirror Management¶
create_snapmirrorupdate_snapmirrordelete_snapmirrorinitialize_snapmirrorupdate_snapmirror_transferbreak_snapmirrorresync_snapmirror
SVM Management¶
create_svmupdate_svmdelete_svm
Qtree Management¶
create_qtreeupdate_qtreedelete_qtree
Network Interface Management¶
create_network_ip_interfaceupdate_network_ip_interfacedelete_network_ip_interface
LUN and igroup Management¶
create_lunupdate_lundelete_luncreate_igroupupdate_igroupdelete_igroupadd_igroup_initiatorremove_igroup_initiatorcreate_lun_mapdelete_lun_map
iSCSI Management¶
create_iscsi_serviceupdate_iscsi_servicedelete_iscsi_service
FCP Management¶
create_fcp_serviceupdate_fcp_servicedelete_fcp_servicecreate_fc_interfaceupdate_fc_interfacedelete_fc_interface
NVMe Management¶
create_nvme_serviceupdate_nvme_servicedelete_nvme_servicecreate_nvme_subsystemupdate_nvme_subsystemdelete_nvme_subsystemadd_nvme_subsystem_hostremove_nvme_subsystem_hostcreate_nvme_namespaceupdate_nvme_namespacedelete_nvme_namespacecreate_nvme_subsystem_mapdelete_nvme_subsystem_map
Multi-Cluster Management¶
list_registered_clusters