Skip to main content
Glama

Get DataLens QL chart

datalens_charts_ql_get
Read-onlyIdempotent

Retrieve a flat DataLens QL chart by ID, with optional branch, revision, links, permissions, and favorite status.

Instructions

One QL chart. Unlike a chart of the wizard it comes flat, with no entry around it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
branchNoThe version to read when no revision is named: `saved` or `published`. A save writes the saved one: read `saved` before changing a chart.
rev_idNoOne revision to read, as it is; give it or `branch`, not both.
chart_idYesChart id.
workbook_idNoThe workbook the chart lies in.
include_linksNoAlso say what it is linked to.
include_favoriteNoAlso say whether it is a favourite of the caller.
include_permissionsNoAlso say what the caller may do with it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.122.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered. The description adds a genuine structural detail that the response is flat with no `entry` wrapper, unlike wizard charts, which helps the agent interpret output, but says nothing about permissions, pagination, or error behavior.

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?

Two short sentences, front-loaded with the resource and followed by the one differentiating fact. Every word earns its place, though the fragmentary phrasing ("comes flat") is slightly more cryptic than it needs to be.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description partially compensates by noting the flat shape with no `entry` wrapper. However, for a 7-parameter read tool it does not describe the branch/rev_id read semantics or what the returned chart contains, leaving some gaps for an agent working without an output schema.

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% (branch, rev_id, chart_id, workbook_id, include_* flags are all documented in the schema), so the schema carries semantics. The description adds no parameter-level meaning beyond that, which is the baseline 3 case.

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?

The description states the resource ("One QL chart") and explicitly distinguishes it from the wizard chart variant, which is a real sibling (datalens_charts_wizard_get). The retrieval verb is only implied by the tool name rather than stated in the description, so it stops short of a 5.

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?

"One QL chart" implies fetching a single chart, but there is no explicit when-to-use guidance, no mention of prerequisites (chart_id, workbook_id), and no named alternative such as datalens_charts_wizard_get or datalens_charts_editor_get that would tell an agent which chart-get to pick.

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