Skip to main content
Glama
deslicer

MCP Server for Splunk

by deslicer

List Users

list_users

Retrieve Splunk users with details like username, roles, and email. Supports pagination and search filters to find specific accounts.

Instructions

Retrieve Splunk users and their properties (username, realname, email, roles, type, defaultApp). If has_more is true, call again with offset=next_offset.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
countNoPage size. Default 50. Maximum 200. Values above 200 are capped to 200; 0 uses 50. Do not send a count larger than 200.
offsetNoResult offset (default 0)
search_filterNoSplunk REST search filter (e.g. 'name=*admin*')

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.6.12
    • changedInput schema / properties / count / description
      Previous value: -"Page size 1-200 (default 50)"New value: +"Page size. Default 50. Maximum 200. Values above 200 are capped to 200; 0 uses 50. Do not send a count larger than 200."
  2. Changed3 schema fields changedv0.6.11
    • addedInput schema / properties / count
      Added value: +{
      +  "default": 50,
      +  "description": "Page size 1-200 (default 50)",
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "description": "Result offset (default 0)",
      +  "type": "integer"
      +}
    • addedInput schema / properties / search_filter
      Added value: +{
      +  "default": "",
      +  "description": "Splunk REST search filter (e.g. 'name=*admin*')",
      +  "type": "string"
      +}
  3. Changed1 schema field changedv0.5.1
    • addedInput schema / additionalProperties
      Added value: +false
  4. First observedv0.5.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the burden of behavioral disclosure. It reveals pagination mechanics (has_more, next_offset) and the set of returned user properties, going beyond a simple one-liner. It does not mention permissions or rate limits, but for a read-only retrieval tool the disclosed behavior is sufficient.

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 with no filler. The core purpose and return fields are front-loaded, and the pagination rule is delivered in a compact, actionable second sentence. Every word earns its place.

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 there is no output schema, the description does a good job of conveying the response shape by naming properties and the has_more/next_offset fields. It could be more explicit about response wrapper structure or permission requirements, but it gives an agent enough to paginate and understand the data being returned.

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?

The input schema already documents all three parameters with 100% coverage, so the baseline is 3. The description adds meaningful context by explaining how offset should be used with next_offset during pagination, which is not present in the schema's generic 'Result offset' description.

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 begins with a specific verb ('Retrieve') and a clear resource ('Splunk users'), then enumerates the exact properties returned. This unambiguously separates it from sibling tools like list_config_files or list_saved_searches, which target entirely different resources.

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 gives clear pagination guidance ('If has_more is true, call again with offset=next_offset'), which is a concrete usage instruction. It does not explicitly mention when not to use the tool, but the resource specificity makes the intended context obvious and there are no close alternatives to exclude.

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