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.

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_boards"
  }
}

Input 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
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / depth / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "minimum": 1,
      -    "type": "integer"
      -  }
      -]New value: +[
      +  {
      +    "type": "string"
      +  },
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": 1,
      +    "type": "integer"
      +  }
      +]
    • addedInput schema / properties / page / maximum
      Added value: +9007199254740991
  2. 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"
  3. 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"
      -]
  4. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description goes beyond that by explaining the aggregation semantics of `asset_count` (counts the board plus all nested boards, each group/stack once) and how that differs from what list_assets returns — a non-obvious behavioral trait. Pagination behavior is also disclosed.

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?

Three sentences, front-loaded with the core purpose, then capabilities, then the one subtle caveat. The final sentence is long but every clause carries information the agent cannot get from structured fields. Minor density cost, no wasted framing.

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?

With no output schema, the description should ideally convey what a returned board record contains; it only surfaces `asset_count` and leaves the rest of the response shape (ids, titles, nesting fields) undisclosed. For a five-parameter list tool this is a meaningful gap, though pagination, depth, and search semantics are all covered.

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 `page`, `depth`, `query`, `per_page`, and `organization` are all already documented upstream. The description largely restates the schema's own `depth` examples ('1' = top-level, 'all' = full tree) and adds no format or syntax detail beyond it; the `asset_count` discussion concerns output, not input parameters. 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?

The first sentence gives a specific verb and resource ("List boards (collections) in a Playbook workspace") and even disambiguates the term "boards" as "collections." It doesn't explicitly contrast itself with close siblings like list_board_children or list_board_descendants, though the depth explanation implicitly covers that ground.

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?

Offers concrete operational guidance: use `query` for title search, `depth` for hierarchy control, and `page` to navigate paginated results. It also crosses tool boundaries usefully by telling the agent to compare `asset_count` against list_assets with `nested_assets: true` rather than the plain listing, which is exactly the kind of routing advice that prevents misuse.

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