Introduction to the Skylar One Base SyncPack

 

This section describes the "Skylar One Base" SyncPack, which contains a set of tools used by the Model Context Protocol (MCP) server introduced in version 3.4.0 of Skylar Automation.

Contents of the Skylar One Base SyncPack

This section lists the contents of the "Skylar One Base" SyncPack.

The following MCP tools and their filters work in conjunction with the MCP server introduced in version 3.4.0 of Skylar Automation. For more information, see the Configuring the Skylar Automation MCP Server chapter in the Skylar Automation manual.

MCP Components in Version 1.1.0

The following tools let an AI assistant query your Skylar One environment directly, including devices, business services, topology, metrics, events, and run book automations.

19 of the 20 tools in this release are read-only. The initiate_event_runbook_automation changes external state as it executes an automation against your Skylar One instance.

• Devices

• get_device_status. Returns current status and severity for one device (device_id).

• find_devices. Finds devices by name, ip_address, or device_class; partial match on any combination, at least one is required.

• get_device_summary. Returns an operational summary for one device (device_id): hostname, IP, status, severity, device class, organization, date added.

• get_direct_related_devices . Returns direct topology relationships for a device (device_id), paginated via cursor.

• Business Services

• find_business_services. Finds business services by name or label, at least one required.
• get_business_service_summary. Returns operational detail for one business service (service_id): health, availability, risk, description, organization.
• list_device_business_services. Lists business services directly related to a device (device_id), paginated.
• get_business_service_topology. Returns a bounded hierarchy (nodes/edges) for a business service (service_id), with configurable depth (1–4) and max_nodes (up to 250); flags truncated: true if the hierarchy exceeds the node cap.

• Locations

• get_entity_locations. Returns configured latitude and longitude for a mix of devices (device_ids) and business services (business_service_ids, up to 25 each). Entities without configured coordinates land in unlocated with a reason instead of failing the call.

• Metrics and Performance

• list_available_device_metrics. Lists collected metrics for a device (device_id), including which Dynamic Application each comes from. Optional name filter.
• get_device_metrics. Returns time-series history for up to 10 named metrics on one device (device_id, metric_names, duration such as 1h/24h).
• compare_device_metrics. Compares up to 5 named metrics across 2–10 devices on one time series. Devices that do not collect a requested metric land in unavailable_devices with a reason rather than failing the whole call.

• Events and Automations

• list_available_event_runbook_automations. Lists enabled, user-selectable Run Book Automation policies currently available for given event_ids. Read-only, never initiates anything.
• list_device_events_with_runbook_automations. Lists active events for one or more devices (device_ids, up to 10) plus the automations available for each, with optional minimum_severity filter.
• initiate_event_runbook_automation. Not read-only. Executes a specific, user-selected run book automation (runbook_policy_id) against a specific active event (event_id). Revalidates that the automation is currently enabled and available for that exact event before executing, and rejects staleor invalid policy IDs.

• Organization and Inventory

• list_organizations. Lists Skylar One organizations (ID, name; description is always null. The SL1 organization resource has no description field).
• list_device_classes. Lists device classes (vendor/model), with name and description populated.
• get_device_interfaces. Returns network interfaces for a device (device_id): name, status, speed, IP address, MAC address.
• get_device_logs. Returns log entries for a device (device_id): timestamp, severity level, message, source.
• get_device_config_data. Returns configuration data collections for a device (such as. BGP peers, OSPF neighbors, IP SLA operations), with human-readable parsed values (such as BGP state "Established" rather than a raw code). Optional config_name_filter; set fetch_data=false to get collection metadata only.

MCP Components in Version 1.0.0

The following tools let an AI assistant query your Skylar One environment directly:

• list_devices. Returns a paginated list of devices from Skylar One. All filters are optional and can be combined. Filters include:

  • device_id. Integer. Filters to a specific device.

  • severity_level. Integer of one to five. The minimum severity to return. Five is the most severe.

  • device_class. String. Filters by device class name.

  • collector_group_name. String. Filters by collector group name.

  • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

  • cursor. String. Pagination cursor from a previous response.

• list_events. Returns a paginated list of active events, ordered by the most recent first. Filters include:

  • device_id. Integer. Filters events to a specific device.

  • severity_level. Integer of one to five. The minimum severity to return. Five is the most severe.

  • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

  • cursor. String. Pagination cursor from a previous response.

• get_asset_by_device_id. Returns asset records (hardware inventory) associated with a device. Filter includes:

  • device_id. Integer. Required. The ID of the device that contains the asset records.

• list_business_services. Returns a paginated list of business services. All filters are optional. Filters include:

  • risk_level. Integer of one to five. The minimum risk level to return.

  • health_level. Integer of one to five. The minimum health degradation level to return.

  • unavailable_only. Boolean. If true, only returns unavailable services.

  • name_contains. String. Filters by partial name matches.

  • limit. Integer between 1 and 50. Defines results per page. The default value is 10.

  • cursor. String. Pagination cursor from a previous response.

• get_appliance_status. Returns status information for all appliances in the Skylar One instance (excludes Collector Unit and Message Collector appliance types). No additional parameters.

All paginated tools return a cursor in the response. Pass the cursor as the cursor parameter on the next call to fetch the next page.