zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zms_list_policy_rules

Read-only

List ZMS microsegmentation policy rules.

Instructions

List ZMS microsegmentation policy rules.

Read-only. Returns one row per rule (id, name, action, priority, enabled). Filter by name/action. fetch_all bypasses pagination — use sparingly. Requires ZSCALER_CUSTOMER_ID.

Input Schema

TableJSON Schema

Name	Required	Description
`name`	No
`query`	No	Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Examples: "[?enabled==`true`]", "[*].{name: name, id: id}", "length(@)". Omit to get the full records. IMPORTANT: field names are the keys of the returned records, which are usually snake_case (`custom_category`) even where the Zscaler API documents camelCase (`customCategory`) — guessing the spelling yields an empty list that looks like a real answer. If you have not already seen a record from this tool, call it once without `query` and read the keys off the response.
`action`	No
`page_num`	No
`fetch_all`	No
`page_size`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / action / title
```
Added value: +"Action"
```
addedInput schema / properties / fetch_all / title
```
Added value: +"Fetch All"
```
addedInput schema / properties / name / title
```
Added value: +"Name"
```
addedInput schema / properties / page_num / title
```
Added value: +"Page Num"
```
addedInput schema / properties / page_size / title
```
Added value: +"Page Size"
```

changedInput schema / properties / query / description

Previous value: -"Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Field names are exactly what the Zscaler API returns. Examples: \"[?enabled==`true`]\", \"[*].{name: name, id: id}\", \"length(@)\". Omit to get the full records."New value: +"Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Examples: \"[?enabled==`true`]\", \"[*].{name: name, id: id}\", \"length(@)\". Omit to get the full records. IMPORTANT: field names are the keys of the returned records, which are usually snake_case (`custom_category`) even where the Zscaler API documents camelCase (`customCategory`) — guessing the spelling yields an empty list that looks like a real answer. If you have not already seen a record from this tool, call it once without `query` and read the keys off the response."

addedInput schema / properties / query / title
```
Added value: +"Query"
```

addedInput schema / title

Added value: +"zms_list_policy_rulesArguments"

Changed16 schema fields changedv0.14.0Jul 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```

removedInput schema / properties / action / description

Removed value: -"Filter by policy action: 'ALLOW' or 'BLOCK' (exact match)."

removedInput schema / properties / action / title
```
Removed value: -"Action"
```

removedInput schema / properties / fetch_all / description

Removed value: -"Whether to fetch all rules ignoring pagination (default false)."

removedInput schema / properties / fetch_all / title
```
Removed value: -"Fetch All"
```

removedInput schema / properties / name / description

Removed value: -"Filter by policy rule name (substring match)."

removedInput schema / properties / name / title
```
Removed value: -"Name"
```
removedInput schema / properties / page_num / description
```
Removed value: -"Page number (default 1)."
```
removedInput schema / properties / page_num / title
```
Removed value: -"Page Num"
```

removedInput schema / properties / page_size / description

Removed value: -"Number of items per page (default 20, max 100)."

removedInput schema / properties / page_size / title
```
Removed value: -"Page Size"
```

changedInput schema / properties / query / description

Previous value: -"JMESPath expression for client-side filtering/projection on the result. Example: \"nodes[?action=='ALLOW'].{name: name, priority: priority}\"."New value: +"Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Field names are exactly what the Zscaler API returns. Examples: \"[?enabled==`true`]\", \"[*].{name: name, id: id}\", \"length(@)\". Omit to get the full records."

removedInput schema / properties / query / title
```
Removed value: -"Query"
```

removedInput schema / properties / service

Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "The service to use.",
-  "title": "Service"
-}

removedInput schema / title

Removed value: -"zms_list_policy_rulesArguments"

changedOutput schema / (root)

Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "zms_list_policy_rulesOutput",
-  "type": "object"
-}New value: +null

First observedv0.12.7Jun 24, 2026

TDQS

A4.4/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, but the description adds meaningful behavior beyond that: one row per rule with specific fields, filter behavior, fetch_all pagination warning, and the requirement for ZSCALER_CUSTOMER_ID. This exceeds the minimum bar set by the annotations.

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?

The description is compact and front-loaded, covering purpose, read-only status, return shape, filtering, pagination caution, and a required context value in four short lines. Every sentence adds useful information with no fluff.

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 names the returned fields (id, name, action, priority, enabled) and gives essential operational context (read-only, filters, fetch_all caution, required customer ID). It does not detail page_size/page_num interaction, but the schema defaults cover the pagination basics.

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 description coverage is low (17%), but the description compensates by explaining that name and action are filters and that fetch_all bypasses pagination. The query parameter is thoroughly documented in the schema itself, while page_num/page_size are self-evident from their names and defaults.

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

Purpose5/5

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

The description clearly states the action ('List') and the specific resource ('ZMS microsegmentation policy rules'). It also distinguishes from siblings like zms_list_default_policy_rules by naming the microsegmentation scope and specifying the returned fields.

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?

The description provides clear usage context: it is a read-only listing operation with filters by name/action and a caution about fetch_all bypassing pagination. It does not explicitly name alternatives or exclusion conditions, so it misses the top bar for guidelines, but context is unambiguous.

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

Deploy Server

zms_list_policy_rules

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools