Skip to main content
Glama

NEM Explorer (ScadaMiner)

get_dashboard_guide

Read-onlyIdempotent

Read this BEFORE authoring or editing a saved dashboard for the first time in a session. Gives the full spec: the panel vocabulary (markdown / chart / table / stat), how queries are named and referenced, viewer-controlled parameters (region, date window), drill-through links between dashboards, shared CTEs, how a viewer extracts a panel's data as a table or CSV, and the rules whose violation gets a save refused. Cheap, and it is the difference between one save_dashboard call and three rejected ones.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_dashboard_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
question_idNoOptional UUID returned by an earlier `start_question` call. When provided, this tool call is attributed to that question.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so safety is covered. The description adds value the annotations cannot: the cost signal ('Cheap'), the consequence of skipping it (rejected saves), and the fact that the payload contains normative rules whose violation blocks a save. It stops short of describing the return format (prose vs structured spec), which keeps it below a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the imperative and timing constraint before the content list, so an agent can act after the first clause. The long enumeration of guide topics is dense but each item is a distinct capability the agent may need to look up. The closing cost/benefit sentence earns its place by justifying the call.

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 documentation-retrieval tool with no output schema, the description does the necessary work of saying what is inside the guide and why it is worth calling. The main remaining gap is return shape and size beyond the word 'cheap,' which matters for deciding whether to inline the result into context. Otherwise complete for this tool's complexity.

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?

There is only one parameter, and schema description coverage is 100%, so `question_id` is already fully documented as an optional UUID from `start_question`. The description never mentions it and adds no meaning beyond the schema. Baseline 3 applies when the schema does all the work.

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 and resource ('Read this... Gives the full spec') and immediately enumerates the domain it covers: panel vocabulary, query naming, viewer parameters, drill-through, shared CTEs, CSV extraction, and save-refusal rules. That enumeration is enough to distinguish it from `save_dashboard`, `get_dashboard`, and `build_chart` without opening any schema.

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

Usage Guidelines5/5

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

Gives an explicit trigger ('BEFORE authoring or editing a saved dashboard for the first time in a session') and an implicit exclusion via 'for the first time in a session,' so the agent knows not to re-read on every call. It also names the downstream tool the guidance feeds into ('one `save_dashboard` call vs three rejected ones'), tying the guide to a concrete workflow.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.