zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zia_list_device_groups

Read-only

List ZIA device groups.

Instructions

List ZIA device groups.

Input Schema

TableJSON Schema

Name	Required	Description
`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.
`include_device_info`	No
`include_pseudo_groups`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / include_device_info / title
```
Added value: +"Include Device Info"
```
addedInput schema / properties / include_pseudo_groups / title
```
Added value: +"Include Pseudo Groups"
```

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: +"zia_list_device_groupsArguments"

Changed10 schema fields changedv0.14.0Jul 28, 2026

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

removedInput schema / properties / include_device_info / description

Removed value: -"Include or exclude device information in the response. When True, each device group includes its associated devices. Default is False for faster response."

removedInput schema / properties / include_device_info / title
```
Removed value: -"Include Device Info"
```

removedInput schema / properties / include_pseudo_groups / description

Removed value: -"Include or exclude Zscaler Client Connector (ZCC) and Cloud Browser Isolation (CBI) related device groups. Default is True to show all groups."

removedInput schema / properties / include_pseudo_groups / title
```
Removed value: -"Include Pseudo Groups"
```

changedInput schema / properties / query / description

Previous value: -"JMESPath expression for client-side filtering/projection of results."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: -{
-  "default": "zia",
-  "description": "The service to use.",
-  "title": "Service",
-  "type": "string"
-}

removedInput schema / title

Removed value: -"zia_list_device_groupsArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

C2.6/5.0

Behavior2/5

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

The readOnlyHint annotation already declares this as read-only, but the description adds no extra behavioral context—no mention of return format, pagination, or any side effects. Given the annotation, the bar is lower, but the description contributes nothing beyond the annotation.

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?

The description is extremely concise and front-loaded with the core purpose. There is no wasted text. However, it is so brief that it borders on under-specification, but the single sentence is clear and efficient.

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

Completeness2/5

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

For a simple listing tool with three optional parameters and no output schema, the description is inadequate. It omits any details about what the parameters do, what the response looks like, or any caveats, making it incomplete for an agent to use effectively.

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

Parameters1/5

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

The description provides zero information about the three parameters. Schema coverage is only 33% (only 'query' has a description), and the description fails to compensate for the undocumented 'include_device_info' and 'include_pseudo_groups' parameters, leaving them unexplained.

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?

The description 'List ZIA device groups.' clearly states the action (list) and resource (device groups) with a specific product context (ZIA). It is unambiguous, though it doesn't distinguish from many sibling list tools except by resource name.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives. There is no mention of prerequisites, filtering options, or comparison with similar tools like zia_list_devices or zid_list_groups.

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

Deploy Server

zia_list_device_groups

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools