zscaler-mcp-server

Official

Overview Schema Source Related Servers Discussions Admin

zpa_list_segment_groups

Read-only

List ZPA segment groups using search, pagination, and microtenant filters. Apply a JMESPath expression to filter or project fields for targeted results.

Instructions

List ZPA segment groups.

Each row is the full segment-group record with normalized highlights (ids, enabled state, application-segment counts/ids, timestamps) on top.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	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
`page_size`	No
`microtenant_id`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed8 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / microtenant_id / title
```
Added value: +"Microtenant Id"
```
addedInput schema / properties / page / title
```
Added value: +"Page"
```
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 / properties / search / title
```
Added value: +"Search"
```

addedInput schema / title

Added value: +"zpa_list_segment_groupsArguments"

Changed16 schema fields changedv0.14.0Jul 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```
removedInput schema / properties / microtenant_id / description
```
Removed value: -"Microtenant ID for scoping."
```
removedInput schema / properties / microtenant_id / title
```
Removed value: -"Microtenant Id"
```

changedInput schema / properties / page / anyOf

Previous value: -[
-  {
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

removedInput schema / properties / page / description
```
Removed value: -"Page number for pagination."
```
removedInput schema / properties / page / title
```
Removed value: -"Page"
```

changedInput schema / properties / page_size / anyOf

Previous value: -[
-  {
-    "minimum": 1,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

removedInput schema / properties / page_size / description
```
Removed value: -"Items per page for pagination."
```
removedInput schema / properties / page_size / title
```
Removed value: -"Page Size"
```

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 / search / description

Removed value: -"Server-side substring match on the segment group's `name` field. Returns the full set of matches in this tenant — no fuzzy matching, no synonym expansion. An empty list means no segment group name contains this string; do not retry with split keywords or no filter."

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

removedInput schema / properties / service

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

removedInput schema / title

Removed value: -"zpa_list_segment_groupsArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

B3.4/5.0

Behavior3/5

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

Annotations declare readOnlyHint=true, and the description adds that each row includes normalized highlights (ids, enabled state, application-segment counts/ids, timestamps). However, it does not disclose pagination behavior or response size limits, which would be valuable for a list tool.

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: one sentence states the operation, a second describes the output characteristics. Every word adds value, with no redundancy or filler.

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

Completeness3/5

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

Given the read-only nature and list operation, the description is adequate at a high level, but it lacks details about pagination, search semantics, and microtenant scoping. Without an output schema, more detail about the returned fields and record structure would be useful.

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

Parameters2/5

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

Schema description coverage is only 20%, so the description should compensate by explaining the parameters. It does not mention any of the five parameters, leaving page, search, page_size, and microtenant_id unexplained. Only the query parameter is described in the schema itself.

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 starts with 'List ZPA segment groups', a specific verb and resource. It further clarifies the output structure (full records with normalized highlights), distinguishing it from other list tools in the sibling set, such as zpa_list_app_connector_groups.

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 explicit guidance on when to use this tool versus alternatives. It does not mention that zpa_get_segment_group exists for retrieving a single record, nor does it provide any exclusions or conditions. Usage is only implied by 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

zpa_list_segment_groups

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools