Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

zia_list_ips_signature_rules

Read-only

List ZIA custom IPS signature rules.

Instructions

List ZIA custom IPS signature rules.

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.
searchNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • 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 / title
      Added value: +"zia_list_ips_signature_rulesArguments"
  2. Changed8 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / page
      Removed value: -{
-  "anyOf": [
-    {
-      "type": "integer"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Page offset for pagination (1-based).",
-  "title": "Page"
-}
    • removedInput schema / properties / page_size
      Removed value: -{
-  "anyOf": [
-    {
-      "type": "integer"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Number of records per page (default = ZIA tenant default).",
-  "title": "Page Size"
-}
    • changedInput schema / properties / query / description
      Previous value: -"JMESPath expression for client-side filtering / projection of the returned signature list (e.g. \"[?contains(name, 'Suricata')]\" or \"[*].{id: id, name: name, sid: rule_text}\")."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"
    • addedInput schema / properties / search
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null
+}
    • removedInput schema / properties / service
      Removed value: -{
-  "default": "zia",
-  "description": "The service to use.",
-  "title": "Service",
-  "type": "string"
-}
    • removedInput schema / title
      Removed value: -"zia_list_ips_signature_rulesArguments"
  3. First observedv0.12.7

TDQS

C2.7/5.0
Behavior2/5

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

The description adds no behavioral context beyond the readOnlyHint annotation. It does not mention side effects, permissions, or data safety, though the annotation covers the read-only nature. No additional value is provided.

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, concise sentence with no redundancy or extra fluff. It efficiently states the operation.

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?

For a simple list operation, the description is minimally adequate but lacks context about output format, pagination, or any special considerations. It meets the basic requirement but does not provide richer context.

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 description does not explain the 'query' or 'search' parameters. The schema already provides a description for 'query', but 'search' lacks one, and the description adds no clarification for either parameter.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('List') and the resource ('ZIA custom IPS signature rules'), distinguishing it from the singular 'get' sibling tools. It is specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives (e.g., zia_get_ips_signature_rule). The description omits any context about filtering, pagination, or scenarios where listing is preferred.

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