Search Docmost pages

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

With no annotations, the description carries the full burden and does not state that this is a read-only operation, how results are ordered or ranked, whether snippets/highlights are returned, or how the 100-result cap interacts with the default of 20. It does disclose the search scope (titles and bodies), which is the only behavioral substance present.

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

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

A single front-loaded sentence with no filler; the scope (titles and bodies) precedes the optional constraint, so the most important information arrives first.

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

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

For a search tool with no annotations and no output schema, the description is minimally viable: the core scope and the three parameters are covered. However, it omits read-only confirmation, result shape, and ordering behavior that an agent would want before invoking a search.

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

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

Schema description coverage is 100%, so the schema already explains query, limit, and spaceId fully. The description only echoes the spaceId constraint ('within one space') and adds no syntax, matching, or ranking semantics beyond what the schema provides — the baseline 3 for full coverage.

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

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

The description gives a specific verb ('full-text searches') and an explicit scope ('page titles and bodies'), which clearly separates it from list_pages and get_page by behavior. It stops short of naming those siblings as alternatives, so it lands at 4 rather than 5.

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

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

'Optionally within one space' hints at the spaceId scoping case but gives no guidance on when to search versus listing or fetching pages directly. No exclusions, prerequisites, or alternative tools are mentioned.

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