Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

zdx_get_deeptrace_events

Read-only

Get the events captured during a ZDX deep trace (curated, nested JSON with ISO timestamps). Read-only.

Instructions

Get the events captured during a ZDX deep trace (curated, nested JSON with ISO timestamps). Read-only.

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.
trace_idYes
device_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / device_id / title
      Added value: +"Device Id"
    • 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 / trace_id / title
      Added value: +"Trace Id"
    • addedInput schema / title
      Added value: +"zdx_get_deeptrace_eventsArguments"
  2. Changed9 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / device_id / description
      Removed value: -"The unique ID for the ZDX device."
    • removedInput schema / properties / device_id / title
      Removed value: -"Device Id"
    • addedInput schema / properties / query
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "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 / service
      Removed value: -{
-  "default": "zdx",
-  "description": "The service to use.",
-  "title": "Service",
-  "type": "string"
-}
    • removedInput schema / properties / trace_id / description
      Removed value: -"The unique ID for the deeptrace session."
    • removedInput schema / properties / trace_id / title
      Removed value: -"Trace Id"
    • removedInput schema / title
      Removed value: -"zdx_get_deeptrace_eventsArguments"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "zdx_get_deeptrace_eventsOutput",
-  "type": "object"
-}New value: +null
  3. First observedv0.12.7

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, and the description reaffirms 'Read-only.' It adds a small behavioral detail about the return format ('curated, nested JSON with ISO timestamps'), but does not disclose other traits like pagination, size limits, or error behavior. Since annotations cover safety, a baseline of 3 is appropriate.

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, well-structured sentence that conveys core purpose and output format without fluff. It is front-loaded with the action and resource, and every clause adds value.

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?

For a tool with two required parameters, no output schema, and low parameter coverage, the description is insufficient. It lacks usage guidance, parameter explanations, and behavioral details beyond the bare minimum. The presence of annotations and a few keywords does not fill the gaps completely.

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?

Schema description coverage is only 33% (only 'query' has a description). The tool description itself does not explain any parameter meanings or relationships. It fails to compensate for the low coverage, leaving trace_id and device_id completely unaddressed.

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 action: 'Get the events captured during a ZDX deep trace' with a specific resource and purpose. It also adds useful context about the output format ('curated, nested JSON with ISO timestamps'), which distinguishes it from sibling tools like zdx_get_deeptrace_cloudpath and zdx_get_deeptrace_health_metrics that return different data.

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 prerequisites, scenarios, or exclusions. While the naming suggests it is for deep trace events, there is no explicit direction about when to choose this over sibling tools.

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