Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ztw_list_ip_groups_lite

Read-only

Retrieve Zscaler Zero Trust IP group records via a lightweight read-only endpoint. Get full group data for filtering, integration, or audit without heavy API overhead.

Instructions

List ZTW IP groups via the lighter SDK endpoint (read-only).

Same records as ztw_list_ip_groups; uses the lite endpoint.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • 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: +"ztw_list_ip_groups_liteArguments"
  2. Changed8 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • 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: -"Optional search string for filtering list results."
    • 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_ip_groups_liteArguments"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "ztw_list_ip_groups_liteOutput",
-  "type": "object"
-}New value: +null
  3. First observedv0.12.7

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already indicate readOnlyHint=true and openWorldHint=false; the description reinforces read-only but adds context about the lite endpoint and identical records, which goes beyond annotations. However, it doesn't elaborate on what 'lite' means in terms of payload, performance, or potential differences in response fields, leaving some behavioral ambiguity.

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 extremely concise: two sentences that immediately state the purpose and the key differentiator. Every word adds value, and it is front-loaded with the core action and resource.

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?

For a simple list tool with two optional params and no output schema, the description covers the core function and sibling relationship. However, it omits details about what the lite endpoint changes (e.g., response size) and the use of the 'search' parameter, leaving minor but noticeable gaps that could affect proper invocation.

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 50% (query is well-documented, but search has no description). The tool description does not mention any parameters, failing to compensate for the undocumented 'search' parameter or clarify its usage, leaving a semantic gap.

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 ZTW IP groups via a lite endpoint, with a specific verb and resource. It also distinguishes itself from the sibling `ztw_list_ip_groups` by explicitly noting it uses the lite endpoint yet returns the same records, setting clear expectations.

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 names the alternative `ztw_list_ip_groups` and clarifies the relationship (same records, lite endpoint), effectively guiding the agent to use this version when a lighter call is preferred. It doesn't explicitly state when NOT to use it or provide detailed decision criteria, but the context is clear enough for selection.

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