Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

zpa_list_provisioning_keys

Read-only

Retrieve ZPA provisioning keys for connector or service edge types, with optional search, pagination, and JMESPath filtering for targeted results.

Instructions

List ZPA provisioning keys of a given type (read-only).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
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
key_typeYes
page_sizeNo
microtenant_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / key_type / title
      Added value: +"Key Type"
    • addedInput schema / properties / microtenant_id / title
      Added value: +"Microtenant Id"
    • addedInput schema / properties / page
      Added value: +{
+  "anyOf": [
+    {
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Page"
+}
    • addedInput schema / properties / page_size
      Added value: +{
+  "anyOf": [
+    {
+      "type": "integer"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Page Size"
+}
    • 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: +"zpa_list_provisioning_keysArguments"
  2. Changed13 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / key_type / description
      Removed value: -"Type of key: 'connector' or 'service_edge'."
    • addedInput schema / properties / key_type / enum
      Added value: +[
+  "connector",
+  "service_edge"
+]
    • removedInput schema / properties / key_type / title
      Removed value: -"Key Type"
    • removedInput schema / properties / microtenant_id / description
      Removed value: -"Microtenant ID for scoping."
    • removedInput schema / properties / microtenant_id / title
      Removed value: -"Microtenant Id"
    • 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 / query_params
      Removed value: -{
-  "anyOf": [
-    {
-      "additionalProperties": true,
-      "type": "object"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "Optional query parameters for filtering.",
-  "title": "Query Params"
-}
    • addedInput schema / properties / search
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null
+}
    • removedInput schema / properties / service
      Removed value: -{
-  "default": "zpa",
-  "description": "The service to use.",
-  "title": "Service",
-  "type": "string"
-}
    • removedInput schema / title
      Removed value: -"zpa_list_provisioning_keysArguments"
    • changedOutput schema / (root)
      Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "zpa_list_provisioning_keysOutput",
-  "type": "object"
-}New value: +null
  3. First observedv0.12.7

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, and the description only repeats 'read-only' without adding pagination behavior, output shape, or side-effect caveats. The query parameter description adds useful JMESPath and snake_case warnings, but the core tool description provides minimal behavior beyond the annotation.

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?

A single front-loaded sentence with no filler or redundant elaboration. It is appropriately concise for the limited scope it claims.

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?

This is a six-parameter tool with no output schema, but the description omits pagination defaults, return format, microtenant behavior, and search semantics. The detailed query warning is helpful, but the overall definition is incomplete for safe and effective 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?

The description only covers the concept of 'given type' for key_type, while schema description coverage is only 17%. Parameters such as page, search, page_size, and microtenant_id are left unexplained, so the description does not compensate for the low schema coverage.

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 ('List'), the resource ('ZPA provisioning keys'), and the scope ('of a given type'). This distinguishes it from sibling tools like zpa_get_provisioning_key and other ZPA list operations.

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?

No guidance is given for when to use this tool versus alternatives, such as zpa_get_provisioning_key or other ZPA list tools. The read-only note is a safety property but does not explain selection context or exclusions.

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