Skip to main content
Glama
alexgoller

Illumio MCP Server

by alexgoller
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

get-workloads

Get workloads from the PCE. Use detail_level to control breadth vs depth: 'compact' (default) for tabular overviews of thousands of workloads, 'full' for complete data on specific workloads, 'labels_only' for maximum breadth with just…

Instructions

Get workloads from the PCE. Use detail_level to control breadth vs depth: 'compact' (default) for tabular overviews of thousands of workloads, 'full' for complete data on specific workloads, 'labels_only' for maximum breadth with just identity and labels.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoFilter by workload name (supports partial matches)
labelsNoJSON-encoded list of label URIs to filter by
onlineNoFilter online (true) or offline (false) workloads
managedNoFilter managed (true) or unmanaged (false) workloads
hostnameNoFilter by hostname (supports partial matches)
ip_addressNoFilter by IP address (supports partial matches)
descriptionNoFilter by description (supports partial matches)
max_resultsNoMaximum number of workloads to return (default 10000)
detail_levelNoLevel of detail. 'compact' (default): tabular summary with key fields, labels, and VEN health (ven_status, last_heartbeat_on, agent_version, policy_sync_state, health_errors) -- enough for 'stale VEN' questions without 'full'. 'full': complete workload data including services, VEN agent, interfaces. 'labels_only': minimal table of href, name, hostname, and labels.compact
enforcement_modeNoFilter by enforcement mode

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.11.0
    • changedInput schema / properties / detail_level / description
      Previous value: -"Level of detail. 'compact' (default): tabular summary with key fields and labels. 'full': complete workload data including services, VEN agent, interfaces. 'labels_only': minimal table of href, name, hostname, and labels."New value: +"Level of detail. 'compact' (default): tabular summary with key fields, labels, and VEN health (ven_status, last_heartbeat_on, agent_version, policy_sync_state, health_errors) -- enough for 'stale VEN' questions without 'full'. 'full': complete workload data including services, VEN agent, interfaces. 'labels_only': minimal table of href, name, hostname, and labels."
  2. Changed11 schema fields changedv0.8.0
    • addedInput schema / properties / description
      Added value: +{
+  "description": "Filter by description (supports partial matches)",
+  "type": "string"
+}
    • addedInput schema / properties / detail_level
      Added value: +{
+  "default": "compact",
+  "description": "Level of detail. 'compact' (default): tabular summary with key fields and labels. 'full': complete workload data including services, VEN agent, interfaces. 'labels_only': minimal table of href, name, hostname, and labels.",
+  "enum": [
+    "compact",
+    "full",
+    "labels_only"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / enforcement_mode
      Added value: +{
+  "description": "Filter by enforcement mode",
+  "enum": [
+    "visibility_only",
+    "full",
+    "idle",
+    "selective"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / hostname
      Added value: +{
+  "description": "Filter by hostname (supports partial matches)",
+  "type": "string"
+}
    • addedInput schema / properties / ip_address
      Added value: +{
+  "description": "Filter by IP address (supports partial matches)",
+  "type": "string"
+}
    • addedInput schema / properties / labels
      Added value: +{
+  "description": "JSON-encoded list of label URIs to filter by",
+  "type": "string"
+}
    • addedInput schema / properties / managed
      Added value: +{
+  "description": "Filter managed (true) or unmanaged (false) workloads",
+  "type": "boolean"
+}
    • addedInput schema / properties / max_results
      Added value: +{
+  "description": "Maximum number of workloads to return (default 10000)",
+  "type": "integer"
+}
    • addedInput schema / properties / name / description
      Added value: +"Filter by workload name (supports partial matches)"
    • addedInput schema / properties / online
      Added value: +{
+  "description": "Filter online (true) or offline (false) workloads",
+  "type": "boolean"
+}
    • removedInput schema / required
      Removed value: -[
-  "name"
-]
  3. Addedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full behavioral burden. It discloses the scale/breadth tradeoff (tabular overviews of thousands vs. complete data on specific workloads), which is genuinely useful, but says nothing about pagination, the default result cap, or authentication/PCE-connection prerequisites implied by siblings like check-pce-credentials-status.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the action and then the key parameter tradeoff. Every clause earns its place and nothing is padded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a ten-parameter read tool with no output schema and no annotations, the description covers the one non-obvious parameter and the scale expectations well. It stops short of mentioning pagination or auth prerequisites, but nothing essential for correct invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so all ten parameters are already documented, establishing a baseline of 3. The description reinforces detail_level with a breadth-vs-depth framing, but adds no syntax or format detail beyond what the enum description already provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Get workloads from the PCE') with no ambiguity about what is returned. However, it never distinguishes itself from close siblings in the list such as get-kubernetes-workloads or get-container-workload-profiles, so an agent must infer the boundary itself.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description does give useful selection guidance for the detail_level parameter (compact for thousands, full for specific workloads, labels_only for breadth), which is a real usage decision. But it offers no when-to-use/when-not guidance for the tool itself versus the Kubernetes/container workload siblings, leaving tool-level routing to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools