Skip to main content
Glama
deslicer

MCP Server for Splunk

by deslicer
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

List Dashboards

list_dashboards

Discover dashboards in Splunk by app, owner, type, and permissions, returning metadata such as name, sharing level, and viewing URLs.

Instructions

List dashboards in Splunk (Simple XML and Dashboard Studio). Returns metadata including name, label, type (classic/studio), app, owner, permissions, sharing level, last updated, and Splunk Web viewing URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appNoFilter by app context. Default: '-' (all apps)-
countNoPage size. Default 50. Maximum 200. Values above 200 are capped to 200; 0 uses 50. Do not send a count larger than 200.
ownerNoFilter by owner. Use 'me' for current user's dashboards, 'nobody' for shared dashboards, or a specific username. Default: 'nobody'nobody
offsetNoResult offset for pagination. Default: 0
type_filterNoFilter by type: 'classic', 'studio', or 'any'. Default: 'any'any
private_onlyNoIf True, only return private dashboards (sharing='user'). Works with any owner filter. Default: False
search_filterNoFilter results (e.g., 'name=*security*')
my_dashboards_onlyNoIf True, only return dashboards owned by the current user. Overrides 'owner' parameter. 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). If has_more, use offset=next_offset"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. Changed1 schema field changedv0.6.11
    • changedInput schema / properties / count / description
      Previous value: -"Max results to return. 0=all, default: 50 for performance"New value: +"Page size 1-200 (default 50). If has_more, use offset=next_offset"
  3. Changed8 schema fields changedv0.6.1
    • addedInput schema / properties / app / description
      Added value: +"Filter by app context. Default: '-' (all apps)"
    • addedInput schema / properties / count / description
      Added value: +"Max results to return. 0=all, default: 50 for performance"
    • addedInput schema / properties / my_dashboards_only / description
      Added value: +"If True, only return dashboards owned by the current user. Overrides 'owner' parameter. Default: False"
    • addedInput schema / properties / offset / description
      Added value: +"Result offset for pagination. Default: 0"
    • addedInput schema / properties / owner / description
      Added value: +"Filter by owner. Use 'me' for current user's dashboards, 'nobody' for shared dashboards, or a specific username. Default: 'nobody'"
    • addedInput schema / properties / private_only / description
      Added value: +"If True, only return private dashboards (sharing='user'). Works with any owner filter. Default: False"
    • addedInput schema / properties / search_filter / description
      Added value: +"Filter results (e.g., 'name=*security*')"
    • addedInput schema / properties / type_filter / description
      Added value: +"Filter by type: 'classic', 'studio', or 'any'. Default: 'any'"
  4. Changed1 schema field changedv0.5.1
    • addedInput schema / additionalProperties
      Added value: +false
  5. First observedv0.5.0

TDQS

A3.8/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 behavioral disclosure burden. It clearly communicates a read-only listing operation and details the returned metadata, including type, ownership, permissions, and viewing URLs. However, it does not explicitly mention absence of side effects, though 'List' and 'Returns metadata' strongly imply a non-mutating operation.

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 compact and front-loaded with the core purpose, followed by a useful but not bloated enumeration of returned fields. Every sentence adds value, and there is no redundant restatement of the tool name.

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 the absence of an output schema, the description adequately explains what the tool returns. Paging and filtering behavior are left to the parameter schema, which fully documents them. Minor gap: no guidance about when to prefer sibling tools for dashboard definitions or studio-specific topics, but the core invocation context is complete.

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%, so the input schema already documents all eight parameters and their defaults. The description adds no parameter-level detail beyond what the schema provides, so the baseline score of 3 applies.

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 states a specific verb and resource ('List dashboards in Splunk') and further scopes it to 'Simple XML and Dashboard Studio.' It also defines the returned metadata fields, which helps distinguish it from tools like get_dashboard_definition that fetch full dashboard definitions.

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?

No guidance is given for when to use this tool versus alternatives such as get_dashboard_definition or list_dashboard_studio_topics. The description implies a listing use case but never states exclusions or directs the agent to a sibling when a different kind of dashboard access is needed.

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