Skip to main content
Glama
Sign In
Illumio MCP Server

Illumio MCP Server

by alexgoller
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

get-rulesets

Retrieve rulesets and their allow, deny, or override-deny rules from draft or active Illumio policy, with filters for scope labels, actor labels, name, and status.

Instructions

Get rulesets and their rules, from draft or active policy, rendered as data: scopes as [{key, value, href}], consumers/providers as {label: {key, value, href}} | {all_workloads: true} | {ip_list: {name, href}} | {label_group: {name, href}}, ingress_services as {port, proto} or {service: {name, href}}. Allow, deny and override_deny rules share one shape (rule_type). Rulesets and rules carry created_at, updated_at, update_type and created_by/updated_by as {username, href} when the PCE sends them (username needs GET /users; null if this key may not list users). labels matches ruleset SCOPE; actor_labels returns only the rules that NAME those labels as consumer or provider, in any ruleset -- 'the policy that touches app X'. Each ruleset costs one extra request for its deny rules, so filter where you can.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get-rulesets"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoFilter rulesets by name (supports partial matches)
labelsNoScope filter: key=value or label HREFs, ANDed (['app=shop', 'env=prod'] = rulesets scoped to exactly that app). A pre-encoded JSON string is still accepted.
enabledNoFilter by enabled/disabled status
pversionNoPolicy version to read (default draft). Echoed as policy_version.
actor_sideNoWhich side actor_labels must appear on (default any)
descriptionNoFilter rulesets by description (supports partial matches)
max_resultsNoMaximum number of rulesets to return
actor_labelsNoReturn only rules whose consumers or providers reference ALL of these labels (key=value or HREF). Rulesets with no matching rule are omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.11.0
    • addedInput schema / properties / actor_labels
      Added value: +{
+  "description": "Return only rules whose consumers or providers reference ALL of these labels (key=value or HREF). Rulesets with no matching rule are omitted.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / actor_side
      Added value: +{
+  "description": "Which side actor_labels must appear on (default any)",
+  "enum": [
+    "consumer",
+    "provider",
+    "any"
+  ],
+  "type": "string"
+}
    • changedInput schema / properties / labels / description
      Previous value: -"JSON-encoded list of label URIs to filter by scope"New value: +"Scope filter: key=value or label HREFs, ANDed (['app=shop', 'env=prod'] = rulesets scoped to exactly that app). A pre-encoded JSON string is still accepted."
    • addedInput schema / properties / labels / items
      Added value: +{
+  "type": "string"
+}
    • changedInput schema / properties / labels / type
      Previous value: -"string"New value: +"array"
    • addedInput schema / properties / pversion
      Added value: +{
+  "description": "Policy version to read (default draft). Echoed as policy_version.",
+  "enum": [
+    "draft",
+    "active"
+  ],
+  "type": "string"
+}
  2. Changed5 schema fields changedv0.8.0
    • addedInput schema / properties / description
      Added value: +{
+  "description": "Filter rulesets by description (supports partial matches)",
+  "type": "string"
+}
    • changedInput schema / properties / enabled / description
      Previous value: -"Filter by enabled/disabled status (optional)"New value: +"Filter by enabled/disabled status"
    • addedInput schema / properties / labels
      Added value: +{
+  "description": "JSON-encoded list of label URIs to filter by scope",
+  "type": "string"
+}
    • addedInput schema / properties / max_results
      Added value: +{
+  "description": "Maximum number of rulesets to return",
+  "type": "integer"
+}
    • changedInput schema / properties / name / description
      Previous value: -"Filter rulesets by name (optional)"New value: +"Filter rulesets by name (supports partial matches)"
  3. Addedv1.0.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description does real work: it discloses the per-ruleset extra request for deny rules ('filter where you can'), that username resolution needs GET /users and comes back null when the key cannot list users, and that timestamps/authors may be absent if the PCE omits them. It doesn't cover pagination behavior or what happens on empty results, so it stops short of full disclosure for an unannotated tool.

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

Conciseness4/5

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

Very dense but nearly every clause carries information the agent needs, especially the render shapes since there is no output schema. It front-loads the return format rather than the core purpose, which is a minor structural weakness, and it is a single unbroken block that is harder to scan.

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?

With no output schema, the description appropriately documents the exact returned shapes (scopes, consumers/providers variants, ingress_services) so an agent can parse results. Combined with the cost warning about unneeded calls, this covers most of what's needed; only pagination/max_results behavior and empty-result handling are left to the schema.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds genuine semantics beyond the schema by framing `labels` as scope-matching versus `actor_labels` as any-ruleset rule-level matching ('the policy that touches app X'). The pversion draft/active meaning is largely already in the schema, keeping it from a 5.

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 and resource ('Get rulesets and their rules, from draft or active policy') and makes clear it returns rules nested inside their rulesets. It does not explicitly name or contrast with read-side siblings like compare-draft-active or get-policy-coverage-report, so an agent must infer the boundary from the name.

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

Usage Guidelines4/5

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

Gives an actionable selection rule between the two filter params: '`labels` matches ruleset SCOPE; `actor_labels` returns only the rules that NAME those labels ... the policy that touches app X.' It also advises 'filter where you can' because of per-ruleset cost. There are no explicit when-not-use cases or named alternatives for the other read tools.

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