Skip to main content
Glama

Search Compass pages

compass_pages_search
Read-only

Keyword search over page titles, bodies, and tags (case-insensitive substring match), paginated. The fast way to check whether a subject already has a page before creating or linking. Returns summaries with a 300-char body snippet — fetch full text with compass_pages_get.

Input Schema

NameRequiredDescriptionDefault
qYesSearch term. Use the most distinctive word or phrase for the subject ('Zendesk', 'invoice approval') — not full sentences.
typeNoNarrow to one page type.
limitNoResults per page, 1-25. Default 10.
offsetNoPagination offset. Default 0.
workspaceNoWorkspace slug. Personal tokens with no default workspace MUST pass this; tokens with a default can override per call. Ignored for workspace API keys.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already establish the safe read-only, non-destructive, closed-world profile, so the bar is lower. The description adds genuinely useful behavior beyond that: match semantics, pagination, and the fact that results are truncated to a 300-char body snippet with a pointer to fetch full text.

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 tight sentences, front-loaded with the operation and its scope, then the primary use case, then the return-format caveat. Every sentence earns its place with no filler.

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 no output schema, the description steps in to describe the return shape (summaries with a 300-char snippet) and the path to full content. Combined with the annotations and fully-described schema, an agent has everything needed to call this correctly.

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 all five parameters (including `workspace` auth nuance and `q` guidance). The description adds nothing parameter-specific beyond noting the search fields and pagination, which is the correct baseline when the schema does the heavy lifting.

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?

States a specific verb and resource ('Keyword search over page titles, bodies, and tags') and precisely characterizes matching semantics (case-insensitive substring). It also distinguishes itself from the sibling `compass_pages_get`, so an agent can route without opening a schema.

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 a clear use case ('fast way to check whether a subject already has a page before creating or linking') and an explicit alternative for full text (`compass_pages_get`). It does not differentiate from the other sibling `compass_pages_list`, which is a plausible source of confusion.

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