Skip to main content
Glama
Zabbix MCP Server

Zabbix MCP Server

module_get

Read-only

Retrieve registered Zabbix frontend modules and inspect their IDs, paths, status, and configuration; filter by enabled/disabled state, ID, or path to audit or manage custom UI extensions.

Instructions

Retrieve registered frontend modules. Modules extend the Zabbix web interface with custom pages, dashboard widgets, or other UI components. Each module has a status (enabled/disabled) and metadata about its ID, relative path, and configuration.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of results to return.
filterNoReturn only results whose properties exactly match the given values (a single value or a list of values per key). Example: {"status": 0} or {"status": [0, 1]}. Keys: config, id, moduleid, relative_path, status. Text properties cannot be filtered; use 'search' for them.
outputNoProperties of the module object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: moduleid, relative_path, status. Properties: config, id, moduleid, relative_path, status.
searchNoReturn results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {"name": "web"}. Keys: id, relative_path.
serverNoTarget Zabbix server. Available: default. Defaults to 'default' if omitted.
raw_jsonNoStrips the security disclaimer preamble from the response so it is pure JSON. Default: false. Requires the bearer token to have 'allow_raw_json' explicitly enabled by an operator in the admin portal - tokens without that policy receive a PolicyError instead. WARNING: setting true bypasses the prompt-injection mitigation marker that wraps untrusted Zabbix data (host names, item descriptions, problem text). LLM clients (Claude, GPT, Cursor, ...) should leave this false; only programmatic non-LLM consumers (Python scripts, n8n workflows that json.loads the result) should set true.
moduleidsNoReturn only modules with the given IDs.
sortfieldNoSort by one or more of: moduleid, relative_path (a list for several; pair with 'sortorder'). No other property is sortable.
sortorderNoSort order: 'ASC' (ascending) or 'DESC' (descending).
countOutputNoReturn the count of matching results instead of the actual data.
searchByAnyNoIf true, return results matching ANY search field (OR). Default is ALL fields (AND).
extra_paramsNoOther native module.get parameters, merged into the request as-is. module.get has no parameters beyond the typed ones. Any other key is refused here, because Zabbix would silently ignore it. For a parameter you are sure exists on your release but is not listed, use zabbix_raw_api_call.
searchWildcardsEnabledNoIf true, enable * and ? wildcards in search patterns.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv1.42.2
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / extra_params / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": true,
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "propertyNames": {
      +      "enum": [
      +        "excludeSearch",
      +        "preservekeys",
      +        "startSearch"
      +      ]
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / filter / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": true,
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "propertyNames": {
      +      "enum": [
      +        "config",
      +        "id",
      +        "moduleid",
      +        "relative_path",
      +        "status"
      +      ]
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / filter / description
      Previous value: -"Return only results whose properties exactly match the given values (a single value or a list of values per key). Example: {\"status\": 0} or {\"status\": [0, 1]}. Keys: config (6.4+), id (6.4+), moduleid (6.4+), relative_path (6.4+), status (6.4+). Text properties cannot be filtered; use 'search' for them."New value: +"Return only results whose properties exactly match the given values (a single value or a list of values per key). Example: {\"status\": 0} or {\"status\": [0, 1]}. Keys: config, id, moduleid, relative_path, status. Text properties cannot be filtered; use 'search' for them."
    • changedInput schema / properties / output / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "extend",
      +      "count"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "enum": [
      +        "config",
      +        "id",
      +        "moduleid",
      +        "relative_path",
      +        "status"
      +      ],
      +      "type": "string"
      +    },
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / output / description
      Previous value: -"Properties of the module object to return. Pass 'extend' for all, 'count' for the number of matches only, or a comma-separated list of property names. Default when omitted: moduleid, relative_path, status. Properties: config (6.4+), id (6.4+), moduleid (6.4+), relative_path (6.4+), status (6.4+)."New value: +"Properties of the module object to return. Pass 'extend' for all, 'count' for the number of matches only, or a list of property names. Default when omitted: moduleid, relative_path, status. Properties: config, id, moduleid, relative_path, status."
    • changedInput schema / properties / search / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": true,
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "propertyNames": {
      +      "enum": [
      +        "id",
      +        "relative_path"
      +      ]
      +    },
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / search / description
      Previous value: -"Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {\"name\": \"web\"}. Keys: id (6.4+), relative_path (6.4+)."New value: +"Return results whose string properties contain the given pattern (case-insensitive; '*' is a wildcard when searchWildcardsEnabled is true). Example: {\"name\": \"web\"}. Keys: id, relative_path."
    • changedInput schema / properties / sortfield / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "moduleid",
      +      "relative_path"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "enum": [
      +        "moduleid",
      +        "relative_path"
      +      ],
      +      "type": "string"
      +    },
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / sortfield / description
      Previous value: -"Sort by one or more of: moduleid, relative_path (comma-separated for several; pair with 'sortorder'). No other property is sortable."New value: +"Sort by one or more of: moduleid, relative_path (a list for several; pair with 'sortorder'). No other property is sortable."
    • changedInput schema / properties / sortorder / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "ASC",
      +      "DESC"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "items": {
      +      "enum": [
      +        "ASC",
      +        "DESC"
      +      ],
      +      "type": "string"
      +    },
      +    "minItems": 1,
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "result": {
      -      "title": "Result",
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "result"
      -  ],
      -  "title": "module_getOutput",
      -  "type": "object"
      -}New value: +null
  2. First observedv1.41.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds useful domain context about what a module record contains (status enabled/disabled, ID, relative path, configuration), but says nothing about pagination, default result size, or output truncation beyond what the schema states.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the action and followed by a definition of the resource. The middle sentence earns its place by explaining what modules are; nothing is padded.

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 13-parameter read tool with no output schema, the description is adequate but thin: it hints at returned fields yet never states the default output set (moduleid, relative_path, status) or that 'extend'/'count' exist. The rich schema compensates for most parameter gaps, but return-shape information lives only in the schema.

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

Parameters3/5

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

Schema coverage is 100% with 13 well-documented parameters, so the schema carries the semantics. The description only confirms that modules have status/ID/relative_path/config fields, which loosely aligns with filterable and returnable properties but adds no filtering, sorting, or output-selection guidance.

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?

States a specific verb and resource ('Retrieve registered frontend modules') and explains what a module is (custom pages, dashboard widgets, UI components). An agent can distinguish it from dashboard_get or settings_get, though the description never names a sibling to contrast with.

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?

There is no guidance on when to call this versus alternatives, no mention of prerequisites (e.g., that modules must be uploaded to the frontend modules directory), and no pointer to zabbix_raw_api_call for unsupported cases, which only appears inside the schema.

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