Skip to main content
Glama
Wasim-Shaikh25

splunk-dashboard-mcp

get_dashboard

Fetches a Splunk dashboard's full definition (Dashboard Studio or Classic SimpleXML) with its owner, sharing, format, and write permission.

Instructions

Fetch one dashboard's full definition (Dashboard Studio JSON or Classic Simple XML), its app/owner/sharing, detected format, and your can_write flag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appNoApp namespace. Default: SPLUNK_DEFAULT_APP (search).
nameYesDashboard (view) name/id.
ownerNoOwner username. Default: any (-).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. 'Fetch' implies a read-only operation, and it usefully lists what is returned. However, it does not explicitly state that the operation is non-destructive, note auth requirements, or describe error behavior (e.g., dashboard not found).

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?

A single front-loaded sentence that leads with the core purpose before listing return contents. Zero filler—every clause 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?

With no output schema, the description adequately enumerates what the tool returns (definition, sharing metadata, format, can_write flag). For a simple fetch tool whose params are fully schema-documented, this is largely sufficient; only error handling and explicit read-only status are unaddressed.

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 all three parameters (app, name, owner) are already documented. The description adds little parameter-specific meaning beyond the schema, mentioning app/owner only as part of the return value rather than as call guidance. Baseline 3 is appropriate when the schema carries the load.

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?

States a specific verb ('Fetch'), a specific resource ('one dashboard's full definition'), and enumerates the return contents (format, app/owner/sharing, can_write flag). This clearly distinguishes it from siblings like list_dashboards (enumeration), check_dashboard_access (access check), and create/update_dashboard (mutations).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'one dashboard's full definition' implies this tool is for retrieving a single dashboard's complete definition rather than listing or checking access, but no alternatives are named and no exclusions given. Usage context is inferred rather than explicit.

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