Skip to main content
Glama

List DataLens workbooks

datalens_workbooks_list
Read-onlyIdempotent

List DataLens workbooks in a collection or root with title filtering, sorting, limits, and optional ownership or permission details. Browse contents without entering nested collections.

Instructions

The workbooks of one collection (the root by default), auto-paginated.

It does not descend into nested collections: collections_content_list shows what a collection holds. Capped at the configured item cap unless limit is given.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax workbooks to return; omitted means the configured cap (YCLI__HTTP__MAX_ITEMS).
only_myNoKeep only what the caller created.
order_fieldNoWhat to sort by.
collection_idNoCollection to list; the root when left out.
filter_stringNoKeep the workbooks whose title has this text.
order_directionNoSort direction.
include_permissions_infoNoAlso say what the caller may do with it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.122.1

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already carry readOnly/idempotent/openWorld, so the bar is lower, but the description adds real behavior: results are auto-paginated, it does not descend into nested collections, and output is capped at the configured item cap unless limit is given. These are useful operational traits beyond the annotations.

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 compact sentences: scope first, then the exclusion and cap behavior. Front-loaded and every sentence earns its place, though the cap detail slightly overlaps the schema's own limit description.

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 needed and all seven params optional and fully schema-documented, the description covers the essentials an agent needs: scope, default root, pagination, nesting limitation, and the item cap. Only the return shape is unspecified, which is acceptable given no output schema exists.

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 the schema already documents all seven parameters including limit's default cap behavior. The description only echoes the limit/cap relationship without adding syntax or meaning the schema lacks, so the baseline 3 is appropriate.

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 (list) and resource (workbooks) scoped to 'one collection (the root by default)', and explicitly distinguishes itself from the sibling it is not: collections_content_list. An agent can tell precisely what this returns without opening a schema.

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

Usage Guidelines4/5

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

Names the alternative (collections_content_list) and the condition that selects it (when you need to descend into nested collections). Clear when-to-use context, though it does not contrast against other list siblings such as datalens_workbooks_list_by_ids or datalens_workbooks_entries_list.

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