Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler

ztw_list_admins

Read-only

List ZTW admin users in Zscaler Zero Trust Exchange. Use search, filtering, and pagination to find specific admins for read-only review.

Instructions

List ZTW admin users (read-only).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
queryNoOptional 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.
searchNo
versionNo
page_sizeNo
include_api_rolesNo
include_admin_usersNo
include_auditor_usersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / include_admin_users / title
      Added value: +"Include Admin Users"
    • addedInput schema / properties / include_api_roles / title
      Added value: +"Include Api Roles"
    • addedInput schema / properties / include_auditor_users / title
      Added value: +"Include Auditor Users"
    • 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 / properties / version / title
      Added value: +"Version"
    • addedInput schema / title
      Added value: +"ztw_list_adminsArguments"
  2. Changed22 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / action
      Removed value: -{
      -  "default": "list_admins",
      -  "description": "Action to perform: 'list_admins' or 'get_admin'.",
      -  "title": "Action",
      -  "type": "string"
      -}
    • removedInput schema / properties / admin_id
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "description": "Admin ID for get_admin action.",
      -  "title": "Admin Id"
      -}
    • removedInput schema / properties / include_admin_users / description
      Removed value: -"Include / exclude admin users in the response."
    • removedInput schema / properties / include_admin_users / title
      Removed value: -"Include Admin Users"
    • removedInput schema / properties / include_api_roles / description
      Removed value: -"Include / exclude API roles in the response."
    • removedInput schema / properties / include_api_roles / title
      Removed value: -"Include Api Roles"
    • removedInput schema / properties / include_auditor_users / description
      Removed value: -"Include / exclude auditor users in the response."
    • removedInput schema / properties / include_auditor_users / title
      Removed value: -"Include Auditor Users"
    • removedInput schema / properties / page / description
      Removed value: -"The page offset to return."
    • removedInput schema / properties / page / title
      Removed value: -"Page"
    • removedInput schema / properties / page_size / description
      Removed value: -"The number of records to return per page."
    • 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: -"The search string to filter by."
    • 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 / properties / version / description
      Removed value: -"Specifies the admins from a backup version."
    • removedInput schema / properties / version / title
      Removed value: -"Version"
    • removedInput schema / title
      Removed value: -"ztw_list_adminsArguments"
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "result": {
      -      "anyOf": [
      -        {
      -          "items": {
      -            "additionalProperties": true,
      -            "type": "object"
      -          },
      -          "type": "array"
      -        },
      -        {
      -          "additionalProperties": true,
      -          "type": "object"
      -        },
      -        {
      -          "type": "string"
      -        }
      -      ],
      -      "title": "Result"
      -    }
      -  },
      -  "required": [
      -    "result"
      -  ],
      -  "title": "ztw_list_adminsOutput",
      -  "type": "object"
      -}New value: +null
  3. First observedv0.12.7

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 annotation but adds no additional behavioral context such as side effects, permissions, or performance implications. Since annotations already cover read-only, the description contributes no extra transparency.

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 concise sentence with no redundant words or irrelevant details. It is appropriately sized for the straightforward listing operation.

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?

Given the large number of sibling list tools and 8 parameters, the description is incomplete. It lacks context on parameter usage, return format, or any distinguishing features, making it insufficient for a complex API endpoint.

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 does not explain any of the 8 parameters (e.g., page, version, include_admin_users). With only 13% schema description coverage, the description fails to compensate for the missing parameter detail, leaving the agent without guidance on how to use these inputs.

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 verb 'List' and the resource 'ZTW admin users', making the purpose unambiguous. It distinguishes from sibling list tools by specifying the exact resource type.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention filtering, pagination, or typical use cases, leaving the agent to guess based on the resource name alone.

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

Deploy Server

Other Tools