zscaler-mcp-server

Official

Overview Schema Source Related Servers Discussions Admin

zpa_list_service_edge_groups

Read-only

Retrieve ZPA service edge groups with pagination, search, and JMESPath filtering for precise, read-only access to group data.

Instructions

List ZPA service edge groups (read-only).

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_service_edge_groupsArguments"

Changed12 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"
```

addedInput schema / properties / page

Added value: +{
+  "anyOf": [
+    {
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null
+}

addedInput schema / properties / page_size

Added value: +{
+  "anyOf": [
+    {
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null
+}

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 / query_params

Removed value: -{
-  "anyOf": [
-    {
-      "additionalProperties": true,
-      "type": "object"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Optional query parameters for filtering, searching, or pagination.",
-  "title": "Query Params"
-}

addedInput schema / properties / search

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null
+}

removedInput schema / properties / service

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

removedInput schema / title

Removed value: -"zpa_list_service_edge_groupsArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

A3.9/5.0

Behavior4/5

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

The description explicitly states 'read-only', aligning with the readOnlyHint annotation. It does not describe additional side effects or behaviors, but for a simple list operation, this is sufficient. The annotation reduces the need for further detail.

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 a single, clear sentence with no redundant information. It is well-structured and directly conveys the tool's purpose.

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?

The description provides essential context (what it lists and that it's read-only) but lacks details about return format, pagination, or any special considerations. Given the simplicity of a list operation and the presence of similar sibling tools, this is adequate though not exhaustive.

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?

The tool description provides no explanation of its parameters. The schema has descriptions for only the 'query' parameter, leaving 'page', 'search', 'page_size', and 'microtenant_id' unexplained. Since parameter coverage in the schema is low (20%) and the description does not compensate, the semantics are insufficient.

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 tool lists ZPA service edge groups, which is a specific resource. It includes the read-only qualifier, distinguishing it from mutation tools and making its purpose unambiguous.

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

Usage Guidelines3/5

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

The description does not explicitly state when to use this tool over alternatives. However, the resource name 'service edge groups' is specific enough that an agent can infer its use case, but no direct comparison or exclusion of other list tools is provided.

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_service_edge_groups

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools