zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zia_list_location_groups

Read-only

List ZIA location groups.

Instructions

List ZIA location groups.

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.
`search`	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 / name / title
```
Added value: +"Name"
```

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 / properties / search / title
```
Added value: +"Search"
```

addedInput schema / title

Added value: +"zia_list_location_groupsArguments"

Changed13 schema fields changedv0.14.0Jul 28, 2026

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

removedInput schema / properties / group_type

Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Filter by group type. ZIA supports ``Static`` (manually-curated membership) and ``Dynamic`` (membership driven by location attributes).",
-  "title": "Group Type"
-}

removedInput schema / properties / location_id

Removed value: -{
-  "anyOf": [
-    {
-      "type": "integer"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Return only location groups that include this location ID.",
-  "title": "Location Id"
-}

removedInput schema / properties / name / description

Removed value: -"Filter by exact location group name (forwarded to ZIA's ``name`` query parameter)."

removedInput schema / properties / name / title
```
Removed value: -"Name"
```

removedInput schema / properties / page

Removed value: -{
-  "anyOf": [
-    {
-      "type": "integer"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Page offset for pagination.",
-  "title": "Page"
-}

removedInput schema / properties / page_size

Removed value: -{
-  "anyOf": [
-    {
-      "type": "integer"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Page size. Default 100; maximum 1000.",
-  "title": "Page Size"
-}

changedInput schema / properties / query / description

Previous value: -"JMESPath expression for client-side filtering/projection."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 / search / description

Removed value: -"Server-side substring search across location group attributes (forwarded to ZIA's ``search`` query parameter)."

removedInput schema / properties / search / title
```
Removed value: -"Search"
```

removedInput schema / properties / service

Removed value: -{
-  "default": "zia",
-  "description": "The service to use.",
-  "title": "Service",
-  "type": "string"
-}

removedInput schema / title

Removed value: -"zia_list_location_groupsArguments"

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?

With readOnlyHint=true and no output schema, the description adds nothing beyond the annotation. It does not disclose pagination behavior, result format, or any filtering defaults. The word 'List' aligns with the read-only hint but offers no extra behavioral context.

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—a single sentence with no wasted words. However, given the tool's simplicity, this brevity is appropriate, though it might benefit from a brief mention of filtering options to aid the agent.

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 listing tool with three parameters, no output schema, and a readOnly annotation, the description is too sparse. It does not mention what a location group is, how results are ordered, or how to combine parameters. The detailed query param guidance lives in the schema, but the overall tool description leaves significant gaps for an agent to operate 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 input schema has only 33% description coverage (only 'query' has a detailed explanation). The tool description 'List ZIA location groups' provides no parameter information, failing to compensate for the low schema coverage. Parameters 'name' and 'search' remain unexplained in the description.

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 'List ZIA location groups' clearly states the action (list) and the resource (ZIA location groups), distinguishing it from related tools like zia_get_location_group or zia_list_locations. The purpose is unambiguous and immediately actionable.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives such as zia_get_location_group for a single group or zia_list_locations for locations. There is no mention of prerequisites, frequency, or trade-offs, leaving the agent to infer usage solely from the name.

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_location_groups

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools