zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

get_zia_users

Read-only

Read ZIA users: list with optional filters, or fetch one by ID (read-only).

Instructions

Read ZIA users: list with optional filters, or fetch one by ID (read-only).

Input Schema

TableJSON Schema

Name	Required	Description
`dept`	No
`name`	No
`page`	No
`group`	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.
`user_id`	No
`page_size`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed10 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / dept / title
```
Added value: +"Dept"
```
addedInput schema / properties / group / title
```
Added value: +"Group"
```
addedInput schema / properties / name / title
```
Added value: +"Name"
```
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 / user_id / title
```
Added value: +"User Id"
```
addedInput schema / title
```
Added value: +"get_zia_usersArguments"
```

Changed19 schema fields changedv0.14.0Jul 28, 2026

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

removedInput schema / properties / action

Removed value: -{
-  "const": "read",
-  "default": "read",
-  "description": "Operation to perform. Use 'read' to paginate/filter users or fetch a single user by ID.",
-  "title": "Action",
-  "type": "string"
-}

removedInput schema / properties / dept / description

Removed value: -"Filters by department name (starts with match)."

removedInput schema / properties / dept / title
```
Removed value: -"Dept"
```

removedInput schema / properties / group / description

Removed value: -"Filters by group name (starts with match)."

removedInput schema / properties / group / title
```
Removed value: -"Group"
```

removedInput schema / properties / name / description

Removed value: -"Filters by user name (starts with match)."

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

removedInput schema / properties / page / description

Removed value: -"Page offset for pagination when listing users."

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

removedInput schema / properties / page_size / description

Removed value: -"Page size for listing users. Default is 100; maximum is 1000."

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

addedInput schema / properties / query

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "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 / service

Removed value: -{
-  "default": "zia",
-  "description": "Zscaler service name. Always 'zia' for this tool.",
-  "title": "Service",
-  "type": "string"
-}

changedInput schema / properties / user_id / anyOf

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

removedInput schema / properties / user_id / description

Removed value: -"User ID. When provided, returns a single user; otherwise returns a list of users."

removedInput schema / properties / user_id / title
```
Removed value: -"User Id"
```

removedInput schema / title

Removed value: -"zia_users_managerArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

A3.7/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true, and the description reinforces this with 'read-only'. It adds the list-vs-by-ID behavioral distinction but does not disclose pagination behavior, result shape, or what happens when no filters are supplied. With annotations covering the safety profile, this is acceptable but thin.

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 front-loaded sentence that immediately identifies the resource and operation. Every word earns its place; 'read-only' is slightly redundant with the annotation but not harmful.

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?

With 7 optional parameters, no output schema, and a large sibling tool set, a one-sentence description is insufficient. It does not explain return values, pagination, filter combinations, or the distinction between list and by-ID behavior beyond the bare minimum. The query parameter's rich guidance lives only in the schema, not the description.

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 14%, so the description needed to compensate, but it only generically says 'optional filters' and 'fetch one by ID'. It does not explain dept, name, group, page, page_size, or how user_id relates to the other parameters. Only the query parameter has meaningful schema documentation.

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 uses a specific verb ('Read') and resource ('ZIA users'), and clearly distinguishes the two modes: list with optional filters or fetch one by ID. This is enough to separate it from sibling user-related tools like zid_get_user or get_zia_user_departments.

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 clearly states when to use the tool: for listing ZIA users with optional filters or fetching a single user by ID. It does not explicitly name alternatives or exclusions relative to sibling tools, but the context is clear enough for a simple read operation.

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

Deploy Server

get_zia_users

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools