zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zms_get_agent_group_totp_secrets

Read-only

Get the TOTP secrets for a ZMS agent group (full record).

Instructions

Get the TOTP secrets for a ZMS agent group (full record).

Read-only API call, but the returned values ARE sensitive enrollment credentials — treat them like secrets. Keyed by eyez_id. Requires ZSCALER_CUSTOMER_ID.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`eyez_id`	Yes

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	No	TOTP secret bundle (treat as sensitive credentials).
`eyez_id`	No	Agent group eyez_id (echoed).

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedv0.15.3Aug 19, 2026
- removedInput schema / additionalProperties
```
Removed value: -false
```
- addedInput schema / properties / eyez_id / title
```
Added value: +"Eyez Id"
```
- addedInput schema / title
```
Added value: +"zms_get_agent_group_totp_secretsArguments"
```

Changed12 schema fields changedv0.14.0Jul 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```

removedInput schema / properties / eyez_id / description

Removed value: -"The agent group eyez ID. Use zms_list_agent_groups to find eyez IDs."

removedInput schema / properties / eyez_id / title
```
Removed value: -"Eyez Id"
```

removedInput schema / properties / service

Removed value: -{
-  "anyOf": [
-    {
-      "type": "string"
-    },
-    {
-      "type": "null"
-    }
-  ],
-  "default": null,
-  "description": "The service to use.",
-  "title": "Service"
-}

removedInput schema / title

Removed value: -"zms_get_agent_group_totp_secretsArguments"

addedOutput schema / additionalProperties
```
Added value: +true
```

addedOutput schema / description

Added value: +"ZMS agent-group TOTP secrets — SENSITIVE; nested payload."

addedOutput schema / properties / data

Added value: +{
+  "additionalProperties": true,
+  "description": "TOTP secret bundle (treat as sensitive credentials).",
+  "title": "Data",
+  "type": "object"
+}

addedOutput schema / properties / eyez_id

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Agent group eyez_id (echoed).",
+  "title": "Eyez Id"
+}

removedOutput schema / properties / result

Removed value: -{
-  "items": {
-    "additionalProperties": true,
-    "type": "object"
-  },
-  "title": "Result",
-  "type": "array"
-}

removedOutput schema / required
```
Removed value: -[
-  "result"
-]
```

changedOutput schema / title

Previous value: -"zms_get_agent_group_totp_secretsOutput"New value: +"TotpSecrets"

First observedv0.12.7Jun 24, 2026

TDQS

A4.7/5.0

Behavior5/5

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

The description adds meaningful behavioral context beyond the readOnlyHint annotation: returned values are sensitive secrets, the record is keyed by eyez_id, and a customer ID is required. This helps the agent handle the response appropriately. There is no contradiction with annotations.

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 three sentences, front-loaded with the core purpose, and every sentence adds value: what it gets, the sensitivity warning, the key field, and the required environment variable. No filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter tool with an output schema and readOnly annotation, the description covers all critical aspects: purpose, read-only nature, secret sensitivity, parameter role, and prerequisite. It does not need to describe return values because an output schema is provided.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although the schema has no description for eyez_id, the description adds semantic meaning by stating the data is 'Keyed by eyez_id' and describing the resource as a ZMS agent group. This clarifies that eyez_id is the lookup identifier, partially compensating for the 0% schema description 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 verb and resource: 'Get the TOTP secrets for a ZMS agent group (full record).' This is specific and distinguishes the tool from sibling list/get tools such as zms_list_agent_groups and other ZMS retrieval operations.

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 useful context for when to use the tool: it is a read-only call that returns sensitive enrollment credentials, and it requires ZSCALER_CUSTOMER_ID. It does not explicitly name alternatives or exclusions, but the tool's unique purpose makes this less critical.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server