Skip to main content
Glama

List canvas datasets

list_canvas_datasets
Read-only

List the datasets a canvas dashboard can bind panels to, and the clusters they can be bound for. Call it before building or extending a json dashboard with canvas_present or canvas_patch. Each dataset has id (the binding's dataset), title, description, shape (timeseries suits LineChart, Gauge or a Stat sparkline; value suits Stat or Gauge; table suits Table, BarList, BarChart or Donut; status suits StatusList; histogram suits Histogram or BarChart), unit, has_capacity (it answers capacity_value, so a Gauge scales to it), fits (the components a binding to it may use; any other is refused), parameters (a cluster parameter takes a cluster id below, usually bound with {"$filter":"cluster"}; an application parameter takes an application id, and environment or cluster picks where it runs) and source. Each cluster has id, name and platform_metrics: present (platform_metrics datasets fill), stale, absent (they render unavailable: leave those panels out or say why) or unknown. Read-only; the platform runs the queries, the model never writes PromQL for a panel.

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": "list_canvas_datasets"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds real context beyond that: the platform executes the queries and the model must never write PromQL, and unsupported component bindings are 'refused'. The stale/absent/unknown platform_metrics semantics also tell the agent what to do when data is unavailable. It does not mention result size, pagination, or error behaviour, keeping it short of 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.

Conciseness3/5

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

The purpose and when-to-use guidance are correctly front-loaded, but the remainder is a single dense run-on sentence with deeply nested parenthetical definitions for each dataset field. Every fact is useful, yet the lack of any list or line breaks makes it harder to parse than the content warrants.

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?

With no output schema, the description carries the full burden of documenting the return shape, and it does so thoroughly: per-dataset fields (id, title, description, shape, unit, has_capacity, fits, parameters, source) and per-cluster fields (id, name, platform_metrics). It even maps shape values to compatible chart components, which is exactly the information needed before calling canvas_present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the baseline is 4. The description correctly adds no parameter guidance and instead spends its budget on return-shape semantics, which is the right trade-off.

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?

Starts with a specific verb and resource: 'List the datasets a canvas dashboard can bind panels to, and the clusters they can be bound for.' An agent immediately knows this is a discovery/lookup tool, and it is clearly distinguished from the mutation siblings canvas_present and canvas_patch named later.

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?

Explicit sequencing guidance: 'Call it before building or extending a json dashboard with canvas_present or canvas_patch.' This names both the trigger condition and the alternative tools, leaving nothing to inference about when this tool is required.

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.