zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zms_list_agents

Read-only

List ZMS microsegmentation agents.

Instructions

List ZMS microsegmentation agents.

Read-only. Returns one row per agent (eyez_id, name, connection status, version, OS, IP). Requires ZSCALER_CUSTOMER_ID. Use a returned eyez_id with the agent-group / nonce tools.

Input Schema

TableJSON Schema

Name	Required	Description
`page`	No
`sort`	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.
`search`	No
`sort_dir`	No
`page_size`	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 / 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 / sort / title
```
Added value: +"Sort"
```
addedInput schema / properties / sort_dir / title
```
Added value: +"Sort Dir"
```

addedInput schema / title

Added value: +"zms_list_agentsArguments"

Changed16 schema fields changedv0.14.0Jul 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```
removedInput schema / properties / page / description
```
Removed value: -"Page number (default 1)."
```
removedInput schema / properties / page / title
```
Removed value: -"Page"
```

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"
```

changedInput schema / properties / query / description

Previous value: -"JMESPath expression for client-side filtering/projection on the result. Example: \"nodes[?connection_status=='CONNECTED']\"."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: -"Search filter string to narrow agents by name, IP, etc."

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

removedInput schema / properties / service

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

removedInput schema / properties / sort / description

Removed value: -"Sort field (e.g., 'name', 'connectionStatus')."

removedInput schema / properties / sort / title
```
Removed value: -"Sort"
```
removedInput schema / properties / sort_dir / description
```
Removed value: -"Sort direction: ASC or DESC."
```
removedInput schema / properties / sort_dir / title
```
Removed value: -"Sort Dir"
```

removedInput schema / title

Removed value: -"zms_list_agentsArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

A3.9/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description reinforces it with 'Read-only'. It adds context beyond annotations: requires ZSCALER_CUSTOMER_ID (not in schema) and lists the specific output fields (since no output schema). This is useful but doesn't address pagination or error behavior, so not a 5.

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 three lines, each sentence adds value: purpose, read-only confirmation, return fields, requirement, and downstream usage. No fluff or redundancy.

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?

For a list tool with 6 parameters and no output schema, the description provides the essential return fields, a required input (ZSCALER_CUSTOMER_ID), and a usage hint. However, it does not explain the remaining parameters (page, page_size, sort, etc.) beyond what's in the schema. The query parameter is well documented in the schema, so the description is moderately complete, but could mention pagination behavior.

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?

The schema description coverage is only 17% (only 'query' has a detailed description). The tool description does not explain any parameters such as page, page_size, sort, or search. It only mentions the output fields and a downstream usage tip, which does not compensate for the low parameter coverage. Thus, it adds minimal value beyond the schema.

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 resource 'ZMS microsegmentation agents', and specifies the returned fields (eyez_id, name, connection status, version, OS, IP). This distinguishes it from sibling tools like zms_list_agent_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 description mentions that a returned eyez_id can be used with agent-group/nonce tools, indicating downstream usage but not explicitly when to choose this tool over alternatives. It does not mention when not to use it or name alternative listing tools. The context implies it's for individual agent details, but that's not 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_agents

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools