Skip to main content
Glama

Search pages in a workspace

search_pages

Find AppFlowy pages by title or body text, returning matching page IDs. Enable body=true to search full content; read-only operation.

Instructions

Find pages by title, or by body text when body=true (decodes each document). Returns matches with ids. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoAlso search page body text (slower; decodes each document).
queryYesText to search for.
workspaceYesWorkspace name or id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool is read-only, explains that body=true is slower and decodes documents, and reports that matches are returned with ids. It omits details like result limits or pagination, but covers the key operational profile for a simple search tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences with no filler. The core behavior is front-loaded, the body-mode caveat is included, and the read-only claim is expressed in a single word.

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?

For a search tool with no output schema, the description provides the essential return information ('Returns matches with ids') and the main performance tradeoff. It is sufficient for an agent to invoke correctly, though it does not specify match limits, ordering, or exact matching behavior.

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 coverage is 100%, so the schema already documents workspace, query, and body. The description adds the performance implication of body=true and implies that title-only search is the default, but this is complementary rather than substantial new semantic information.

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?

The description opens with 'Find pages by title, or by body text when body=true' – a precise verb, resource, and search mode. It clearly distinguishes itself from sibling tools like list_pages or get_page by emphasizing search over listing or fetching, and the read-only note clarifies its non-mutating nature.

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?

It gives clear context for when the optional body search is appropriate, including the warning that it 'decodes each document' and is slower. It does not explicitly name sibling tools or state when to prefer list_pages/get_page, so it falls short of full routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.