zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zms_list_resources

Read-only

List ZMS resources (workloads).

Instructions

List ZMS resources (workloads).

Read-only. Returns one row per workload (id, name, type, status, cloud provider/region, OS, IPs). Filter by name/status/type/provider/region/OS. Requires ZSCALER_CUSTOMER_ID.

Input Schema

TableJSON Schema

Name	Required	Description
`name`	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.
`status`	No
`page_num`	No
`page_size`	No
`sort_order`	No
`platform_os`	No
`cloud_region`	No
`resource_type`	No
`cloud_provider`	No
`include_deleted`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed14 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / cloud_provider / title
```
Added value: +"Cloud Provider"
```
addedInput schema / properties / cloud_region / title
```
Added value: +"Cloud Region"
```
addedInput schema / properties / include_deleted / title
```
Added value: +"Include Deleted"
```
addedInput schema / properties / name / title
```
Added value: +"Name"
```
addedInput schema / properties / page_num / title
```
Added value: +"Page Num"
```
addedInput schema / properties / page_size / title
```
Added value: +"Page Size"
```
addedInput schema / properties / platform_os / title
```
Added value: +"Platform Os"
```

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 / resource_type / title
```
Added value: +"Resource Type"
```
addedInput schema / properties / sort_order / title
```
Added value: +"Sort Order"
```
addedInput schema / properties / status / title
```
Added value: +"Status"
```

addedInput schema / title

Added value: +"zms_list_resourcesArguments"

Changed26 schema fields changedv0.14.0Jul 28, 2026

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

removedInput schema / properties / cloud_provider / description

Removed value: -"Filter by cloud provider, e.g. 'AWS', 'AZURE', 'GCP', 'ON_PREMISES' (exact match)."

removedInput schema / properties / cloud_provider / title
```
Removed value: -"Cloud Provider"
```

removedInput schema / properties / cloud_region / description

Removed value: -"Filter by cloud region (substring match)."

removedInput schema / properties / cloud_region / title
```
Removed value: -"Cloud Region"
```

removedInput schema / properties / include_deleted / description

Removed value: -"Whether to include deleted resources (default false)."

removedInput schema / properties / include_deleted / title
```
Removed value: -"Include Deleted"
```

removedInput schema / properties / name / description

Removed value: -"Filter by resource name (substring match)."

removedInput schema / properties / name / title
```
Removed value: -"Name"
```
removedInput schema / properties / page_num / description
```
Removed value: -"Page number (default 1)."
```
removedInput schema / properties / page_num / title
```
Removed value: -"Page Num"
```

removedInput schema / properties / page_size / description

Removed value: -"Number of items per page (default 20, max 100)."

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

removedInput schema / properties / platform_os / description

Removed value: -"Filter by platform OS, e.g. 'LINUX', 'WINDOWS' (substring match)."

removedInput schema / properties / platform_os / title
```
Removed value: -"Platform Os"
```

changedInput schema / properties / query / description

Previous value: -"JMESPath expression for client-side filtering/projection on the result. Example: \"nodes[?cloud_provider=='AWS']\"."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 / resource_type / description

Removed value: -"Filter by resource type, e.g. 'VIRTUAL_MACHINE', 'CONTAINER', 'BARE_METAL' (exact match)."

removedInput schema / properties / resource_type / title
```
Removed value: -"Resource Type"
```

removedInput schema / properties / service

Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "The service to use.",
-  "title": "Service"
-}

removedInput schema / properties / sort_order / description

Removed value: -"Sort order for resource name: 'ASC' or 'DESC'."

removedInput schema / properties / sort_order / title
```
Removed value: -"Sort Order"
```

removedInput schema / properties / status / description

Removed value: -"Filter by resource status (exact match)."

removedInput schema / properties / status / title
```
Removed value: -"Status"
```

removedInput schema / title

Removed value: -"zms_list_resourcesArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

A4/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, so the 'Read-only' line repeats that, but the description adds valuable context: one row per workload, key returned fields, supported filter dimensions, and the ZSCALER_CUSTOMER_ID authentication requirement. Pagination and rate-limit behavior are not disclosed, but this is reasonably transparent for a list tool.

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 short and front-loaded. Every sentence serves a distinct purpose: operation, return shape, filter dimensions, and auth requirement. There is no unnecessary prose or repetition of schema-visible defaults.

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?

Without an output schema, describing returned fields is important and done well. The description does not explicitly mention pagination, sorting, or include_deleted, but those parameters are fairly self-explanatory, and the result shape plus auth are covered. For a moderate-complexity read-only list tool, this is sufficient guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 9%, so the description must compensate. It maps friendly filter names like 'type', 'provider', 'region', and 'OS' to schema concepts (resource_type, cloud_provider, cloud_region, platform_os), which is helpful. However, it omits query, page_num, page_size, sort_order, and include_deleted; the query parameter is thoroughly described in the schema itself, but the others are only self-evident from their names.

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 opens with a specific verb+resource: 'List ZMS resources (workloads).' The parenthetical and the enumerated return fields (id, name, type, status, cloud provider/region, OS, IPs) make the target object unambiguous, distinguishing it from sibling tools like zms_list_agent_groups or zms_list_resource_groups.

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 read-only nature and filterable fields imply its usage: list workloads when you need resource inventory. However, it does not explicitly state when to prefer this over sibling list tools or when not to use it, so the guidance is implied rather than explicit.

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

Deploy Server

zms_list_resources

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools