Skip to main content
Glama
deslicer

MCP Server for Splunk

by deslicer

List Kvstore Collections

list_kvstore_collections

Discover available Splunk KV Store collections with schema details like fields and replication. Filter by app to find collections for lookups, configuration, or caching.

Instructions

List KV Store collections with basic schema details. Use this to discover available KV stores for lookups, configuration, or caching, optionally filtering by app.

Outputs: array of collections with name, fields, accelerated_fields, replicated; and total count. Security: results are constrained by the authenticated user's permissions.Args: app (str, optional): Optional app name to filter collections count (int, optional): Page size. Default 50. Maximum 200. Values above 200 are capped to 200; 0 uses 50. Do not send a count larger than 200. offset (int, optional): Result offset (default 0)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appNo
countNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.6.11
    • addedInput schema / properties / count
      Added value: +{
      +  "default": 50,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "type": "integer"
      +}
  2. Changed1 schema field changedv0.5.1
    • addedInput schema / additionalProperties
      Added value: +false
  3. First observedv0.5.0

TDQS

A4.6/5.0
Behavior5/5

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

No annotations are provided, so the description carries the full behavioral burden and does well. It discloses output shape (array with name, fields, accelerated_fields, replicated; plus total count), security constraints (results constrained by user permissions), and pagination semantics (default 50, max 200, cap behavior, 0 means 50). This is substantial beyond a generic 'list' statement.

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 well organized into purpose, outputs, security, and args, making it easy for an agent to scan. Every sentence contributes operational detail; the slight redundancy of repeating the 200 cap in warning form is negligible.

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 simple listing tool with three optional parameters and no output schema, the description supplies purpose, return shape, permission behavior, and pagination rules. Nothing an agent needs for correct invocation is missing.

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?

Schema description coverage is 0%, but the description fully documents all three parameters: app as an optional filter, count with default/max/cap/zero behavior plus a direct warning, and offset with default. This completely compensates for the bare input schema.

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 action—list KV Store collections—with a clear object and scope ('basic schema details'). It emphasizes discovery of available KV stores, which helps differentiate it from data-access and creation siblings like get_kvstore_data and create_kvstore_collection, though it does not name an alternative explicitly.

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?

Explicitly frames the intended use: 'Use this to discover available KV stores for lookups, configuration, or caching.' It also notes optional app filtering. It does not explicitly state when not to use it or mention sibling alternatives, so it stops short of a 5.

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