Skip to main content
Glama
zscaler

zscaler-mcp-server

Official
by zscaler
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

ztw_get_discovery_settings

Read-only

Retrieve ZTW workload-discovery settings to inspect the current configuration and decision controls. Returns the full settings payload for read-only use.

Instructions

Get ZTW workload-discovery settings (read-only singleton).

Returns the decision-bearing knobs plus the full payload in settings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
settingsNoFull discovery-settings payload (curated container).
external_idNoExternal ID, if set.
discovery_roleNoDiscovery IAM role, if set.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.15.3
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / title
      Added value: +"ztw_get_discovery_settingsArguments"
  2. Changed11 schema fields changedv0.14.0
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / service
      Removed value: -{
-  "default": "ztw",
-  "description": "The service to use.",
-  "title": "Service",
-  "type": "string"
-}
    • removedInput schema / title
      Removed value: -"ztw_get_discovery_settingsArguments"
    • addedOutput schema / additionalProperties
      Added value: +true
    • addedOutput schema / description
      Added value: +"ZTW workload-discovery settings (tenant-wide singleton).\n\nThe SDK object's exact field set varies; the full record surfaces the\ndecision-bearing knobs and keeps the rest in a nested `settings` payload so\nnothing is silently dropped for a config singleton."
    • addedOutput schema / properties / discovery_role
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Discovery IAM role, if set.",
+  "title": "Discovery Role"
+}
    • addedOutput schema / properties / external_id
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "External ID, if set.",
+  "title": "External Id"
+}
    • removedOutput schema / properties / result
      Removed value: -{
-  "additionalProperties": true,
-  "title": "Result",
-  "type": "object"
-}
    • addedOutput schema / properties / settings
      Added value: +{
+  "additionalProperties": true,
+  "description": "Full discovery-settings payload (curated container).",
+  "title": "Settings",
+  "type": "object"
+}
    • removedOutput schema / required
      Removed value: -[
-  "result"
-]
    • changedOutput schema / title
      Previous value: -"ztw_get_discovery_settingsOutput"New value: +"DiscoverySettings"
  3. First observedv0.12.7

TDQS

A4.3/5.0
Behavior4/5

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

Annotations include readOnlyHint=true and openWorldHint=false, and the description aligns with this stating 'read-only singleton'. It adds that the full payload is returned in `settings`, which is not in annotations. No contradiction. The description supplements annotations with return structure info.

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 two sentences, front-loads the purpose, and includes the key detail about the return payload. No redundancy. It is appropriately concise.

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?

Given it is a simple getter with no parameters and an output schema, the description is sufficient. It fully describes the purpose and the main return structure. It could mention any specific settings names, but not necessary for this tool.

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

Parameters5/5

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

No parameters to explain. The schema has no properties, so the description does not need to add parameter semantics. It clearly states there are no inputs, which is sufficient.

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 it gets ZTW workload-discovery settings, identifying it as a read-only singleton. It differentiates from siblings by specifying 'workload-discovery' and using 'get' verb, matching sibling patterns like zia_get_advanced_settings.

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

Usage Guidelines3/5

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

No explicit when to use vs alternatives, but the read-only singleton nature and no parameters imply it is for retrieving settings. Does not mention exclusions or alternatives, but the unique resource type among siblings reduces ambiguity.

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