Skip to content

docs: sync Fabric MCP tools table #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tutkat wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sync Fabric MCP tools table #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 80 additions & 1 deletion docs/servers/fabric-mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,17 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `update_connection` | Update an Equinix Fabric Connection using its UUID | [Update Connection](/api-catalog/fabricv4/#tag/Connections/operation/updateConnectionByUuid) |
| `validate_connection` | Validate a Fabric Connection configuration before creation | [Validate Connection](/api-catalog/fabricv4/#tag/Connections/operation/validateConnections) |
| `retry_connection_action` | Perform actions on a Fabric Connection | [Connection Actions](/api-catalog/fabricv4/#tag/Connections/operation/createConnectionAction) |
| `check_connection` | Validate a connection configuration before creation. | |
| `retry_connection` | Retry a connection operation (creation or deletion). | |
| `search_connections` | Get a list of user's virtual connections using search criteria. | |

### Fabric Metros

| Tool | Description | API Endpoint |
|---------------|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| `get_metro` | Retrieve detailed information about a specific Fabric Metro by passing its Metro Code | [Get Metro by Code](/api-catalog/fabricv4/#tag/Metros/operation/getMetroByCode) |
| `list_metro` | Fetch all metros available in Fabric | [Get All Metros](/api-catalog/fabricv4/#tag/Metros/operation/getMetros) |
| `list_metros` | Fetch all metros available in Equinix Fabric. | |

### Ports

Expand All @@ -46,6 +50,9 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `search_port` | Search for Fabric Ports using advanced filtering, pagination, and sorting | [Search Ports](/api-catalog/fabricv4/#tag/Ports/operation/searchPorts) |
| `update_port` | Update a Fabric Port configuration | [Update Port](/api-catalog/fabricv4/#tag/Ports/operation/updatePortByUuid) |
| `get_vlan_port` | Get VLAN configurations for a specific port | [Get Port VLANs](/api-catalog/fabricv4/#tag/Ports/operation/getVlans) |
| `attach_physical_ports_to_lag` | Add one or more physical ports to an existing virtual LAG port. | |
| `create_port` | Create a new Equinix Fabric port (XF_PORT) via the Fabric API. | |
| `search_ports` | Search for Equinix Fabric ports using advanced filtering, sorting, and pagination. | |

### Cloud Routers

Expand All @@ -59,6 +66,9 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `search_router_commands` | Search for router command execution results | [Search Router Commands](/api-catalog/fabricv4/#tag/Cloud-Routers/operation/searchCloudRouterCommands) |
| `search_routes` | Search for routes including advertised, received, and active routes | [Search Routes](https://docs.equinix.com/fabric-cloud-router/fcr-api/manage-routing-tables-api/) |
| `load_routes` | Create route table actions for a Cloud Router | [Create Route Actions](/api-catalog/fabricv4/#tag/Cloud-Routers/operation/createCloudRouterAction) |
| `list_router_packages` | Retrieve all Fabric Cloud Router package available in Equinix Fabric. | |
| `refresh_routes` | Loads the user's routing table of a Fabric Cloud Router (FCR). | |
| `search_routers` | Search for Equinix Fabric Cloud Routers using advanced filtering, sorting, and pagination. | |

### Routing Protocols

Expand All @@ -68,6 +78,16 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `create_routing_protocols` | Create a new Routing Protocol | [Create Routing Protocols](/api-catalog/fabricv4/#tag/Routing-Protocols/operation/createConnectionRoutingProtocol) |
| `update_routing_protocols` | Update an existing Routing Protocol | [Update Routing Protocols](/api-catalog/fabricv4/#tag/Routing-Protocols/operation/patchConnectionRoutingProtocolByUuid) |
| `replace_routing_protocols` | Replace an existing Routing Protocol | [Update Routing Protocols](/api-catalog/fabricv4/#tag/Routing-Protocols/operation/replaceConnectionRoutingProtocolByUuid) |
| `attach_route_aggregation` | Attach a Route Aggregation to a connection. | |
| `attach_route_filter` | Attach a Route Filter to a connection. | |
| `create_routing_protocol` | Create a single Routing Protocol (DIRECT or BGP) for a connection. | |
| `create_routing_protocol_action` | Create a BGP action on a routing protocol for a connection. | |
| `list_route_aggregations_for_connection` | Get all Route Aggregations attached to a connection, with optional filtering by UUID. | |
| `list_route_filters_for_connection` | Get all Route Filters attached to a connection, with optional filtering by UUID. | |
| `list_routing_protocol_actions` | Get BGP actions for a routing protocol on a connection, optionally filtering by action UUID. | |
| `list_routing_protocols` | This tool fetches Routing Protocols for a specific connection. | |
| `replace_routing_protocol` | Replace a Routing Protocol on a connection using PUT with a full payload. | |
| `update_routing_protocol` | Update a Routing Protocol using JSON Patch operations. | |

### Projects

Expand All @@ -88,6 +108,8 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `get_time_service` | Retrieve detailed information about a specific Precision Time service by UUID | [Get Time Service](/api-catalog/fabricv4/#tag/Precision-Time/operation/getTimeServicesById) |
| `search_time_service` | Search for Equinix Precision Time services | [Search Time Services](/api-catalog/fabricv4/#tag/Precision-Time/operation/searchTimeServices) |
| `update_time_service` | Update a Precision Time service configuration | [Update Time Service](/api-catalog/fabricv4/#tag/Precision-Time/operation/updateTimeServicesById) |
| `create_time_service` | Create a new Equinix Precision Time service. | |
| `search_time_services` | Search for Equinix Fabric Precision time services (ept) using advanced filtering, sorting, and pagination. | |

### Service Profiles

Expand All @@ -98,6 +120,9 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `update_service_profile` | Update an existing Service Profile | [Update Service Profile](/api-catalog/fabricv4/#tag/Service-Profiles/operation/updateServiceProfileByUuid) |
| `replace_service_profile` | Replace a Service Profile configuration | [Replace Service Profile](/api-catalog/fabricv4/#tag/Service-Profiles/operation/putServiceProfileByUuid) |
| `get_service_profile_metros` | Get metro information for a specific Service Profile | [Get Service Profile Metros](/api-catalog/fabricv4/#tag/Service-Profiles/operation/getServiceProfileMetrosByUuid) |
| `get_service_profile` | Retrieve detailed information about a specific service profile by its UUID. | |
| `list_service_profile_metros` | Retrieve the list of metros where a specific service profile is available. | |
| `search_service_profiles` | Search for Equinix Fabric service profiles using advanced filtering, sorting, and pagination. | |

### Service Tokens

Expand All @@ -114,6 +139,11 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `search_route_filter` | Search for Cloud Router Route Filters | [Search Route Filters](/api-catalog/fabricv4/#tag/Route-Filters/operation/searchRouteFilters) |
| `create_route_filter` | Create a new Route Filter for traffic management | [Create Route Filter](/api-catalog/fabricv4/#tag/Route-Filters/operation/createRouteFilter) |
| `update_route_filter` | Update an existing Route Filter configuration | [Update Route Filter](/api-catalog/fabricv4/#tag/Route-Filters/operation/patchRouteFilterByUuid) |
| `get_route_filter_changes` | Retrieve changes or update history of an Equinix Route Filter Policy. | |
| `get_route_filter_changes_by_uuid` | Retrieve a specific change or update log of an Equinix Route Filter Policy. | |
| `list_route_filter_connections` | Retrieve all connections using a specific Route Filter Policy. | |
| `search_route_filter_attachments_for_fcr` | Search for Equinix Route Filter Attachments using advanced filtering, sorting, and pagination. | |
| `search_route_filters` | Search for Equinix Route Filter Policies using advanced filtering, sorting, and pagination. | |

### Route Filter Rules

Expand All @@ -123,6 +153,9 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `get_route_filter_rule` | Get detailed information about a specific Route Filter Rule | [Get Route Filter Rule](/api-catalog/fabricv4/#tag/Route-Filter-Rules/operation/getRouteFilterRuleByUuid) |
| `create_route_filter_rule` | Create new rules for a Route Filter | [Create Route Filter Rules](/api-catalog/fabricv4/#tag/Route-Filter-Rules/operation/createRouteFilterRule) |
| `update_route_filter_rule` | Update an existing Route Filter Rule | [Update Route Filter Rule](/api-catalog/fabricv4/#tag/Route-Filter-Rules/operation/patchRouteFilterRuleByUuid) |
| `get_route_filter_rule_changes` | Retrieve changes or update history of an Equinix Route Filter Rule. | |
| `get_route_filter_rule_changes_by_uuid` | Retrieve a specific change or update log of an Equinix Route Filter Rule. | |
| `list_route_filter_rules` | Retrieve all Route Filter Rules under a specific Route Filter Policy. | |

### Route Aggregation

Expand All @@ -131,6 +164,12 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `search_route_aggregation` | Search for Cloud Router Route Aggregation | [Search Route Aggregation](/api-catalog/fabricv4/#tag/Route-Aggregations/operation/searchRouteAggregations) |
| `create_route_aggregation` | Create a new Route Aggregation for traffic management | [Create Route Aggregation](/api-catalog/fabricv4/#tag/Route-Aggregations/operation/createRouteAggregation) |
| `update_route_aggregation` | Update an existing Route Aggregation configuration | [Update Route Aggregation](/api-catalog/fabricv4/#tag/Route-Aggregations/operation/patchRouteAggregationByUuid) |
| `get_route_aggregation` | Retrieve details for a specific Route Aggregation Policy by UUID. | |
| `get_route_aggregation_changes` | Retrieve changes or update history of an Equinix Route Aggregation Policy. | |
| `get_route_aggregation_changes_by_uuid` | Retrieve a specific change or update log of an Equinix Route Aggregation Policy. | |
| `list_route_aggregation_connections` | Retrieve all connections using a specific Route Aggregation Policy. | |
| `search_route_aggregation_attachments_for_fcr` | Search for Equinix Route Aggregation Attachments using advanced filtering, sorting, and pagination. | |
| `search_route_aggregations` | Search for Equinix Route Aggregation Policies using advanced filtering, sorting, and pagination. | |

### Route Aggregation Rules

Expand All @@ -140,6 +179,9 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `get_route_aggregation_rule` | Get detailed information about a specific Route Aggregation Rule | [Get Route Aggregation Rule](/api-catalog/fabricv4/#tag/Route-Aggregation-Rules/operation/getRouteAggregationRuleByUuid) |
| `create_route_aggregation_rule` | Create new rules for a Route Aggregation | [Create Route Aggregation Rules](/api-catalog/fabricv4/#tag/Route-Aggregation-Rules/operation/createRouteAggregationRule) |
| `update_route_aggregation_rule` | Update an existing Route Aggregation Rule | [Update Route Aggregation Rule](/api-catalog/fabricv4/#tag/Route-Aggregation-Rules/operation/patchRouteAggregationRuleByUuid) |
| `get_route_aggregation_rule_changes` | Retrieve changes or update history of an Equinix Route Aggregation Rule. | |
| `get_route_aggregation_rule_changes_by_uuid` | Retrieve a specific change or update log of an Equinix Route Aggregation Rule. | |
| `list_route_aggregation_rules` | Retrieve all Route Aggregation Rules under a specific Route Aggregation Policy. | |


### Observability - Streams
Expand All @@ -158,6 +200,9 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
| `get_stream_subscription_details` | Get details about a specific telemetry stream subscription | [Get Stream Subscription](/api-catalog/fabricv4/#tag/Stream-Subscriptions/operation/getStreamSubscriptionByUuid) |
| `create_stream_subscription` | Create a new telemetry stream subscription | [Create Stream Subscription](/api-catalog/fabricv4/#tag/Stream-Subscriptions/operation/createStreamSubscriptions) |
| `update_stream_subscription` | Update an existing telemetry stream subscription | [Update Stream Subscription](/api-catalog/fabricv4/#tag/Stream-Subscriptions/operation/updateStreamSubscriptionByUuid) |
| `get_stream_network_edge_device` | Retrieve details of a network edge device attached to an Equinix Fabric Stream. | |
| `list_stream_attached_assets_by_type` | Retrieve a list of all attached assets with the specified type for a specific Equinix Fabric Stream. | |
| `update_stream_network_edge_device` | Attach or replace a network edge device on an Equinix Fabric Stream. | |

### Observability - Stream Alert Rules

Expand All @@ -174,13 +219,47 @@ Delete functionality is not currently supported in the Fabric MCP Server. This i
|-------------------------|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| `get_cloud_event` | Get details about a specific cloud event | [Get Cloud Event](/api-catalog/fabricv4/#tag/Cloud-Events/operation/getCloudEventByAssetId) |
| `search_cloud_events` | Search for cloud events across your Fabric resources | [Search Cloud Events](/api-catalog/fabricv4/#tag/Cloud-Events/operation/searchCloudEvents) |
| `search_cloud_events_by_asset` | Retrieve cloud events related to an Equinix Fabric resource. | |

### Observability - Metrics

| Tool | Description | API Endpoint |
|------------------|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| `get_metrics` | Get metrics for a specific asset by asset ID | [Get Metrics](/api-catalog/fabricv4/#tag/Metrics/operation/getMetricByAssetId) |
| `search_metrics` | Search for metrics across multiple assets | [Search Metrics](/api-catalog/fabricv4/#tag/Metrics/operation/searchMetrics) |
| `get_metric` | Retrieve metric details about an Equinix Fabric resource. | |
| `list_metrics_by_metros` | Retrieve real-time metric details for all Equinix Fabric Metros. | |

### Agent Factories

| Tool | Description | API Endpoint |
| --- | --- | --- |
| `create_agent` | After listing templates, ask the user which one they'd like to use. Do not suggest, highlight, or recommend any template as a best fit — present all options neutrally and let the user decide. | |
| `get_agent_activities` | Retrieve activities for an Equinix Fabric Agent. | |
| `get_agent_details` | Retrieve details about an Equinix Fabric Agent. | |
| `get_agent_template_details` | Retrieve details about an Equinix Fabric Agent Template. | |
| `list_agent_templates` | Retrieve list of agent templates from Equinix Fabric. | |
| `list_agents` | Retrieve list of agents from Equinix Fabric. | |

### Company Profiles

| Tool | Description | API Endpoint |
| --- | --- | --- |
| `get_company_profile` | Retrieve detailed information about a specific Equinix Fabric company profile by its UUID. | |
| `list_company_profile_private_services` | List all private services attached to an Equinix Fabric company profile. | |
| `list_company_profile_service_profiles` | List all service profiles attached to an Equinix Fabric company profile. | |
| `list_company_profile_tags` | List all tags attached to an Equinix Fabric company profile (GET /{uuid}/tags). | |
| `list_predefined_tags` | Retrieve the list of predefined tags available for Equinix Fabric company profiles. | |
| `list_private_services` | Retrieve the list of private services available for Equinix Fabric company profiles. | |
| `search_company_profile` | Search for Equinix Fabric company profiles using advanced filtering, sorting, and pagination. | |

### Networks

| Tool | Description | API Endpoint |
| --- | --- | --- |
| `create_network` | Create a new Equinix Fabric Network. | |
| `search_networks` | Search for Equinix Fabric Networks using advanced filtering, sorting, and pagination. | |
| `update_network` | Update an Equinix Fabric Network attribute. | |



Expand All @@ -203,4 +282,4 @@ The MCP server can help with complex analysis and optimization tasks:

- **"We're looking to rationalize our network footprint. Can you analyze our active and provisioned port, router, and connection utilization across all metros, identify underutilized resources, and suggest optimization strategies to reduce our monthly costs while maintaining performance? Also, can you suggest adding redundancy options to improve resiliency of our network?"** – Performs comprehensive network analysis to identify cost optimization opportunities while maintaining or improving network resilience.
- **"Find metros where we should establish redundant paths but currently don't have them."** – Analyzes network topology to identify single points of failure across metros and recommends redundancy improvements.
- **"Analyze our connection patterns and identify any single points of failure in our network topology."** – Examines connection architecture to detect vulnerabilities and suggest architectural improvements.
- **"Analyze our connection patterns and identify any single points of failure in our network topology."** – Examines connection architecture to detect vulnerabilities and suggest architectural improvements.