zscaler-mcp-server

Official

Overview Schema Source Related Servers Discussions Admin

ztw_list_roles

Read-only

List ZTW admin roles with filtering by search, role IDs, and included role types. Get full records or apply a JMESPath query to refine output.

Instructions

List ZTW admin roles (read-only).

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.
`search`	No
`role_ids`	No
`include_api_roles`	No
`include_auditor_role`	No
`include_partner_role`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed9 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / include_api_roles / title
```
Added value: +"Include Api Roles"
```
addedInput schema / properties / include_auditor_role / title
```
Added value: +"Include Auditor Role"
```
addedInput schema / properties / include_partner_role / title
```
Added value: +"Include Partner Role"
```

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 / role_ids / title
```
Added value: +"Role Ids"
```
addedInput schema / properties / search / title
```
Added value: +"Search"
```
addedInput schema / title
```
Added value: +"ztw_list_rolesArguments"
```

Changed16 schema fields changedv0.14.0Jul 28, 2026

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

removedInput schema / properties / include_api_roles / description

Removed value: -"Include or exclude API role information in the list. Default is True."

removedInput schema / properties / include_api_roles / title
```
Removed value: -"Include Api Roles"
```

removedInput schema / properties / include_auditor_role / description

Removed value: -"Include or exclude auditor user information in the list."

removedInput schema / properties / include_auditor_role / title
```
Removed value: -"Include Auditor Role"
```

removedInput schema / properties / include_partner_role / description

Removed value: -"Include or exclude admin user information in the list. Default is True."

removedInput schema / properties / include_partner_role / title
```
Removed value: -"Include Partner Role"
```

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

Removed value: -"Include or exclude role ID information in the list."

removedInput schema / properties / role_ids / title
```
Removed value: -"Role Ids"
```

removedInput schema / properties / search / description

Removed value: -"Search string to filter roles by name."

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

removedInput schema / properties / service

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

removedInput schema / title

Removed value: -"ztw_list_rolesArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

C2.9/5.0

Behavior2/5

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

The description repeats the read-only trait already declared by readOnlyHint=true and adds no new behavioral context such as pagination, auth requirements, result format, or filtering side effects. openWorldHint=false is also not explained in the description.

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 with no filler or unnecessary detail. It is about as concise as possible for stating the core action and resource, though the redundancy of 'read-only' with annotations is minor.

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?

Despite having six optional parameters and no output schema, the description offers no information about return shape, filtering behavior, or the meaning of the include flags. The query parameter schema provides some context, but the tool description itself is too sparse to be considered complete for complex use.

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 mentions none of the six parameters and does not help map semantics beyond the schema. With schema description coverage at only 17%, the description fails to compensate for the largely undocumented parameters; the only rich parameter documentation lives inside the query field's schema description, not in the tool 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 clearly states the action ('List') and the exact resource ('ZTW admin roles'), and explicitly notes it is read-only. This distinguishes it from sibling tools like ztw_list_admins, which target a different resource.

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?

There is no guidance on when to use this tool versus alternatives, no exclusions, and no contextual examples. The description only restates the resource and read-only nature, leaving the agent to infer usage from the tool name.

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

Deploy Server

ztw_list_roles

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools