Skip to main content
Glama
deslicer

MCP Server for Splunk

by deslicer

List Indexes

list_indexes

Retrieve accessible data indexes from a Splunk instance to identify queryable sources for searches. Supports filtering, internal index inclusion, and pagination.

Instructions

Retrieve accessible data indexes from the Splunk instance. Use this to discover which indexes you can query when building searches. Excludes internal indexes (name starts with _) unless include_internal is true. 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=*sec*')
include_internalNoInclude _internal-style indexes (default false)

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. Changed4 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 / include_internal
      Added value: +{
      +  "default": false,
      +  "description": "Include _internal-style indexes (default false)",
      +  "type": "boolean"
      +}
    • 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=*sec*')",
      +  "type": "string"
      +}
  3. Changed1 schema field changedv0.5.1
    • addedInput schema / additionalProperties
      Added value: +false
  4. First observedv0.5.0

TDQS

A4.2/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 adds important behavioral details not visible in the schema: internal indexes are excluded by default unless include_internal is true, and pagination requires reading has_more and offset=next_offset. This gives the agent actionable expectations beyond the raw input schema.

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?

Three sentences, each earning its place: the core purpose, the default exclusion behavior, and the pagination continuation rule. Information is front-loaded with the most important statement first, and there is no redundant fluff.

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?

For a paginated discovery tool with no output schema and no annotations, the description covers purpose, access scope, internal-index filtering, and pagination. It does not explicitly describe the shape of each returned index object, but it provides enough operational context for an agent to call the tool and continue paginating correctly.

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 description coverage is 100%, so the structured parameter docs already carry the meaning of count, offset, search_filter, and include_internal. The description reinforces include_internal's effect on internal-index visibility and the offset pagination loop, but does not need to repeat per-parameter details.

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 uses a specific verb ('Retrieve') and resource ('data indexes from the Splunk instance'), and frames the tool as a discovery aid for building searches. This clearly distinguishes it from sibling tools that deal with sources, sourcetypes, dashboards, or config files.

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 explicitly states when to use the tool: to discover queryable indexes when building searches. It also communicates the internal-index exclusion behavior and pagination flow, though it does not explicitly name excluded alternatives or when-not-to-use scenarios.

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