Skip to main content
Glama

List boards

list_boards
Read-only

List boards (collections) in a Playbook workspace. Supports title search via query and hierarchy depth control via depth ('1' = top-level only, 'all' = full tree). Results are paginated — use page to navigate. asset_count covers the board AND every board nested under it (each group/stack counted once); list_assets on a board returns only assets sitting directly on it unless you pass nested_assets: true, so compare the count against that, not the plain listing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (1-indexed)
depthNoHierarchy depth: '1' for top-level only, '2', or 'all' for the full tree. Default: '1'.
queryNoSearch boards by title
per_pageNoItems per page (1-100, default 20)
organizationNoWorkspace slug, as returned by list_organizations. Omit it when the account has a single workspace — it is then resolved from your token. Pass it only when the account has several, or when you mean a workspace other than the obvious one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / depth / anyOf
      Added value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "minimum": 1,
      +    "type": "integer"
      +  }
      +]
    • changedInput schema / properties / depth / description
      Previous value: -"Hierarchy depth as a STRING: '1' for top-level only, '2', or 'all' for the full tree. Default: '1'. A bare number is rejected — quote the digit."New value: +"Hierarchy depth: '1' for top-level only, '2', or 'all' for the full tree. Default: '1'."
    • removedInput schema / properties / depth / type
      Removed value: -"string"
  2. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / context
      Removed value: -{
      -  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
      -  "type": "string"
      -}
    • removedInput schema / required
      Removed value: -[
      -  "context"
      -]
  3. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/destructiveHint/openWorldHint, so the safety profile is covered. The description adds genuinely non-obvious behavior: results are paginated, and `asset_count` is recursive (counts the board plus every nested board) while list_assets counts only direct assets unless `nested_assets: true`. That is valuable disclosure beyond structured fields.

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?

Four sentences, front-loaded with purpose then parameter behavior. Dense but each sentence carries real information (search, depth, pagination, count semantics). Slightly long and the last sentence is clause-heavy, but nothing is filler.

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?

No output schema, so the description must carry return semantics, and it does explain pagination and the meaning of `asset_count`. It stops short of describing the board object fields or total-count metadata, leaving minor gaps for a list tool.

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 page, depth, query, per_page, and organization. The description restates the depth values and pagination, adding no syntax or format details the schema lacks; baseline 3 applies.

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?

States a specific verb+resource ('List boards (collections) in a Playbook workspace') and clarifies the hierarchy scope via `depth`, which implicitly separates it from list_board_children / list_board_descendants. It does not name those siblings directly, so it falls short of full sibling differentiation.

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?

Gives concrete context for each relevant mode: title search via `query`, tree breadth via `depth` ('1' vs 'all'), and pagination via `page`. The closing sentence even tells the agent how to reconcile `asset_count` against list_assets output. No explicit when-not-to-use or named alternative tool, so not a 5.

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.

Resources