zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zdx_list_alert_affected_devices

Read-only

List devices affected by a ZDX alert.

Instructions

List devices affected by a ZDX alert.

Read-only. Returns one identifying row per affected device. Filter by location/department/geo, location groups, and the since HOURS window.

Input Schema

TableJSON Schema

Name	Required	Description
`limit`	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.
`since`	No
`geo_id`	No
`offset`	No
`alert_id`	Yes
`location_id`	No
`department_id`	No
`location_groups`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed12 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / alert_id / title
```
Added value: +"Alert Id"
```
addedInput schema / properties / department_id / title
```
Added value: +"Department Id"
```
addedInput schema / properties / geo_id / title
```
Added value: +"Geo Id"
```
addedInput schema / properties / limit / title
```
Added value: +"Limit"
```
addedInput schema / properties / location_groups / title
```
Added value: +"Location Groups"
```
addedInput schema / properties / location_id / title
```
Added value: +"Location Id"
```
addedInput schema / properties / offset / title
```
Added value: +"Offset"
```

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 / since / title
```
Added value: +"Since"
```

addedInput schema / title

Added value: +"zdx_list_alert_affected_devicesArguments"

Changed22 schema fields changedv0.14.0Jul 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```
removedInput schema / properties / alert_id / description
```
Removed value: -"The unique ID for the alert."
```
removedInput schema / properties / alert_id / title
```
Removed value: -"Alert Id"
```
removedInput schema / properties / department_id / description
```
Removed value: -"Filter by department ID(s)."
```
removedInput schema / properties / department_id / title
```
Removed value: -"Department Id"
```
removedInput schema / properties / geo_id / description
```
Removed value: -"Filter by geolocation ID(s)."
```
removedInput schema / properties / geo_id / title
```
Removed value: -"Geo Id"
```

removedInput schema / properties / limit / description

Removed value: -"Number of items to return per request (minimum 1)."

removedInput schema / properties / limit / title
```
Removed value: -"Limit"
```
removedInput schema / properties / location_groups / description
```
Removed value: -"Filter by location group ID(s)."
```
removedInput schema / properties / location_groups / title
```
Removed value: -"Location Groups"
```
removedInput schema / properties / location_id / description
```
Removed value: -"Filter by location ID(s)."
```
removedInput schema / properties / location_id / title
```
Removed value: -"Location Id"
```

removedInput schema / properties / offset / description

Removed value: -"The next_offset value from the last request for pagination."

removedInput schema / properties / offset / title
```
Removed value: -"Offset"
```

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 / service

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

removedInput schema / properties / since / description

Removed value: -"Number of hours to look back (default 2h). Cannot exceed 14 days."

removedInput schema / properties / since / title
```
Removed value: -"Since"
```

removedInput schema / title

Removed value: -"zdx_list_alert_affected_devicesArguments"

changedOutput schema / (root)

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

First observedv0.12.7Jun 24, 2026

TDQS

A3.7/5.0

Behavior3/5

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

The description states 'Read-only', which is consistent with the annotation, but adds little beyond that. It does mention 'Returns one identifying row per affected device', giving a minimal output expectation, but does not disclose any other behavioral traits such as pagination or error handling.

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 concise, using only two sentences to convey purpose, filters, and output format. Every word contributes meaning without redundancy or filler.

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?

The description gives enough to understand what the tool does and its basic output, but does not elaborate on response schema, pagination, or detailed usage context. For a simple read-only list operation, it is adequate but not comprehensive.

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?

The description covers several parameters (location, department, geo, location groups, since) by describing their filter purpose, but does not explicitly name them or cover all parameters (limit, offset, query are omitted). It provides contextual meaning but lacks precise mapping to parameter identifiers.

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 'devices affected by a ZDX alert', making the purpose unambiguous. It also distinguishes this tool from other listing tools by specifying the ZDX alert context.

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 read-only nature and provides filter hints (location/department/geo, location groups, since window), but does not explicitly state when to use this tool over alternatives or provide usage scenarios. It lacks explicit 'when not to use' guidance.

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

Deploy Server

zdx_list_alert_affected_devices

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools