Documentation

Get Board Snapshot Tool

Returns a compact whole-board overview in a single call so an agent can reason about board state without many round-trips. Lists every column in order with its type, task count, and up to 5 open tasks, ending with open-vs-completed totals. Scoped to a project the authenticated user owns or belongs to.

Returns a compact whole-board overview in a single call so an agent can reason about board state without many round-trips. Lists every column in order with its type, task count, and up to 5 open tasks, ending with open-vs-completed totals. Scoped to a project the authenticated user owns or belongs to.

Safety: Read only

Tool names, field names, and schema descriptions remain in canonical MCP English so copied calls match the server exactly.

Input schema

Field Type Required Description
project_name string no The project name (partial, case-insensitive). Provide this or project_id.
project_id integer no The exact project ID. Provide this or project_name.
board_name string no Optional board name (partial, case-insensitive). Defaults to the first board in the project.

Example prompt

Use get-board-snapshot-tool to help me with the relevant Taskavel task.

Example call

{
  "name": "get-board-snapshot-tool",
  "arguments": {}
}

Last reviewed Jul 26, 2026