Skip to main content
Glama

List or search the canvases the user can access. Use this to find a canvas by title or body text before reading or editing it. Searches the stored Markdown body — the same body v1GetCanvasContent returns. Recent writes, including in-app edits (saved after a short delay), may take a few seconds to show up in `match_context` and ranking. `q` runs hybrid full-text search over title and body; omit it to list. `include_workspace=true` adds canvases shared with the whole workspace. Paginate with `limit` (1–100) and `offset`. Use v1GetCanvasContent to read a result's body with its ETag.

listCanvases
Read-onlyIdempotent

List or search the canvases the user can access. Use this to find a canvas by title or body text before reading or editing it.

Searches the stored Markdown body — the same body v1GetCanvasContent returns. Recent writes, including in-app edits (saved after a short delay), may take a few seconds to show up in match_context and ranking. q runs hybrid full-text search over title and body; omit it to list. include_workspace=true adds canvases shared with the whole workspace. Paginate with limit (1–100) and offset. Use v1GetCanvasContent to read a result's body with its ETag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSearch query over title and body (max 500 characters)
limitNoMaximum items per page (1-100)
offsetNoNumber of items to skip
include_workspaceNoAlso include canvases shared with every workspace member

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsNoArray of items for the current page
limitNoMaximum number of items per page
totalNoTotal number of items across all pages
offsetNoNumber of items skipped from the beginning

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / q / description
      Previous value: -"Search query over title and cached body (max 500 characters)"New value: +"Search query over title and body (max 500 characters)"
    • changedOutput schema / properties / items / items / properties / match_context / description
      Previous value: -"Snippet of the cached body around the search match; only present when q was supplied and the body matched"New value: +"Snippet of the body around the search match; only present when q was supplied and the body matched"
  2. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, but the description adds non-obvious behavior: indexing lag for recent writes and in-app edits before they appear in match_context and ranking, plus the hybrid full-text search model. It does not address permission/auth requirements beyond the include_workspace scope, so it falls short of a 5.

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?

Front-loaded with purpose, then behavior, then pagination and the follow-up tool in a logical order; every sentence carries information. It is slightly inflated by restating the title verbatim as the opening sentence and by a redundant pagination clause the schema already covers.

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

Completeness5/5

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

With an output schema present, return values need not be explained, and annotations carry the safety profile. The description still covers the search semantics, workspace scoping, pagination, write-visibility latency, and the correct next tool, which is everything an agent needs to select and call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description adds real semantics beyond the schema: q is a hybrid search over title and body and its omission switches the tool into list mode, and include_workspace widens visibility to whole-workspace items. The pagination sentence largely restates the schema's limit/offset descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tautological: description restates name/title.

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

Usage Guidelines5/5

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

It states the exact triggering condition ('Use this to find a canvas by title or body text before reading or editing it') and names the follow-up tool ('Use v1GetCanvasContent to read a result's body with its ETag'). It also explains the list-vs-search branch ('omit it to list'), leaving nothing to inference.

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