Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

zdx_get_deeptrace_webprobe_metrics

Read-only

Get web-probe metrics captured during a ZDX deep trace (curated, nested time-series JSON). Read-only.

Instructions

Get web-probe metrics captured during a ZDX deep trace (curated, nested time-series JSON). 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_webprobe_metricsArguments"
  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_webprobe_metricsArguments"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "zdx_get_deeptrace_webprobe_metricsOutput",
-  "type": "object"
-}New value: +null
  3. First observedv0.12.7

TDQS

A4.2/5.0
Behavior4/5

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

In addition to the readOnlyHint annotation, the description usefully discloses that the output is a curated, nested time-series JSON structure. This adds meaningful behavioral context since there is no output schema, though it does not cover pagination or detailed response shape.

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, front-loaded sentence with no filler. It covers the action, the resource type, the capture context, and the safety profile without repeating unnecessary information.

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?

The description provides a meaningful output hint for a tool with no output schema, and the complex query caveat is already handled in the input schema. It could be more complete with a cross-reference to sibling deep-trace metric tools, but the core invocation path is sufficiently clear.

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 low and the description does not add much meaning for device_id and trace_id beyond implying they come from a deep trace context. The optional query parameter, however, receives very detailed guidance in the schema itself, which partly compensates for the tool description's brevity.

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 names a precise resource — web-probe metrics — and scopes it to ZDX deep traces, which differentiates it from sibling tools like zdx_get_deeptrace_health_metrics or zdx_get_web_probes. The verb 'Get' and 'Read-only' make the access intent unambiguous.

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 clearly indicates when the tool applies: when web-probe metrics from a ZDX deep trace are needed. It does not name alternatives or explicitly say when not to use it, but the contextual scope 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