Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler

zins_get_web_protocols

Read-only

Get web traffic broken down by protocol (HTTP, HTTPS, SSL, …). Read-only analytics.

Instructions

Get web traffic broken down by protocol (HTTP, HTTPS, SSL, …). Read-only analytics.

One row per protocol with its aggregated total. Window must be a 7- or 14-day historical interval.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
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.
end_timeNo
start_timeNo
end_days_agoNo
traffic_unitNoTRANSACTIONS
start_days_agoNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / end_days_ago / title
      Added value: +"End Days Ago"
    • addedInput schema / properties / end_time / title
      Added value: +"End Time"
    • addedInput schema / properties / limit / title
      Added value: +"Limit"
    • 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 / start_days_ago / title
      Added value: +"Start Days Ago"
    • addedInput schema / properties / start_time / title
      Added value: +"Start Time"
    • addedInput schema / properties / traffic_unit / title
      Added value: +"Traffic Unit"
    • addedInput schema / title
      Added value: +"zins_get_web_protocolsArguments"
  2. Changed16 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / end_days_ago / description
      Removed value: -"Days ago for end. Default: 2. Interval = start - end must be 7 or 14."
    • removedInput schema / properties / end_days_ago / title
      Removed value: -"End Days Ago"
    • removedInput schema / properties / end_time / description
      Removed value: -"ALTERNATIVE: End time as Unix epoch in MILLISECONDS."
    • removedInput schema / properties / end_time / title
      Removed value: -"End Time"
    • removedInput schema / properties / limit / description
      Removed value: -"Maximum number of protocol entries to return (1-1000)."
    • removedInput schema / properties / limit / title
      Removed value: -"Limit"
    • 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 / start_days_ago / description
      Removed value: -"Days ago for start. Default: 9 (7-day interval). API needs 7 or 14 day intervals."
    • removedInput schema / properties / start_days_ago / title
      Removed value: -"Start Days Ago"
    • removedInput schema / properties / start_time / description
      Removed value: -"ALTERNATIVE: Start time as Unix epoch in MILLISECONDS."
    • removedInput schema / properties / start_time / title
      Removed value: -"Start Time"
    • removedInput schema / properties / traffic_unit / description
      Removed value: -"Traffic measurement unit. Values: TRANSACTIONS, BYTES"
    • removedInput schema / properties / traffic_unit / title
      Removed value: -"Traffic Unit"
    • removedInput schema / title
      Removed value: -"zins_get_web_protocolsArguments"
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "result": {
      -      "items": {
      -        "additionalProperties": true,
      -        "type": "object"
      -      },
      -      "title": "Result",
      -      "type": "array"
      -    }
      -  },
      -  "required": [
      -    "result"
      -  ],
      -  "title": "zins_get_web_protocolsOutput",
      -  "type": "object"
      -}New value: +null
  3. First observedv0.12.7

TDQS

A4/5.0
Behavior4/5

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

Annotations already mark readOnlyHint=true, and the description reinforces this with 'Read-only analytics.' It adds behavioral context beyond annotations: the output shape ('One row per protocol with its aggregated total') and the critical window restriction. This is sufficient for a read-only analytics 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 extremely concise: three short sentences that deliver purpose, output shape, and a critical constraint. Every sentence carries meaningful information with no padding or repetition.

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?

Given the tool has 7 parameters and no output schema, the description covers the core purpose and a key constraint but leaves parameter semantics largely unaddressed. An agent would need to infer or look elsewhere for how to properly set time parameters and traffic_unit. This is a moderate gap for reliable invocation.

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?

Schema coverage is very low (14%); only the `query` parameter has a description in the schema. The tool description does not explain the meaning or usage of the other six parameters (start_time, end_time, start_days_ago, end_days_ago, traffic_unit, limit). The vague mention of a 7- or 14-day window does not compensate for the lack of parameter-level guidance.

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 tool's function: 'Get web traffic broken down by protocol (HTTP, HTTPS, SSL, …)' with a specific verb, resource, and grouping dimension. It also notes output granularity ('One row per protocol'), which helps distinguish it from sibling tools like zins_get_web_traffic_by_location and zins_get_web_traffic_no_grouping.

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 provides an explicit usage constraint: 'Window must be a 7- or 14-day historical interval.' This guides when the tool can be used. It doesn't explicitly mention alternatives, but the purpose is specific enough to make such guidance partially implicit.

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