Skip to main content
Glama

Search Documents by Title

search_docs
Read-onlyIdempotent

Search workspace documents by title and optional tag using metadata, returning doc IDs, titles, direct URLs, trash status, and pagination state.

Instructions

Fast search for documents by title using workspace metadata. Much faster than exporting each doc. Returns docId, title, direct URL, and inTrash for each match, plus offset/limit pagination state (hasMore, truncated, and nextOffset).

Input Schema

NameRequiredDescriptionDefault
tagNoOptional tag filter (case-insensitive substring match against resolved tag names).
limitNoMax results to return (default: 20, maximum: 200).
queryYesSearch query — matched case-insensitively against doc titles.
offsetNoZero-based result offset for paging through matches (default: 0).
sortByNoSort by match relevance (default) or by updatedAt.
matchModeNoHow to match titles (default: substring).
workspaceIdNoWorkspace ID (optional if default set).
sortDirectionNoSort direction for updatedAt sorting (default: desc).

Output Schema

NameRequiredDescriptionDefault
okNo
tagNo
codeNo
errorNo
limitNo
queryNo
offsetNo
sortByNo
detailsNo
hasMoreNo
resultsNo
causeCodeNo
matchModeNo
retryableNo
truncatedNo
nextOffsetNo
totalCountNo
sortDirectionNo
recoveryGuidanceNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv3.10.2

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish the safe read-only, idempotent profile, so the bar is lower. The description still adds useful context: the performance characteristic relative to exporting docs, and the exact per-match fields and pagination state (hasMore, truncated, nextOffset) an agent will receive.

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?

Two tight sentences with the purpose front-loaded and the performance benefit immediately after. The second sentence spends its length enumerating return fields that an output schema already covers, which is mild redundancy rather than wasted space.

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?

With an output schema present, the return-value enumeration is not strictly needed, but the performance note and pagination state are helpful. The one gap is any routing signal versus find_doc_by_title, which is the most likely confusion for an agent in this sibling set.

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 all eight parameters including tag, matchMode, sortBy, and matchMode enums are already documented. The description contributes nothing about parameter syntax or behavior beyond the pagination terms it mentions in the return context, hitting the baseline 3.

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

Purpose4/5

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

States a specific verb (search) and resource (documents) with the qualifier that it matches on title using workspace metadata. However, it never acknowledges the closely related sibling find_doc_by_title, so an agent must infer the distinction itself.

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

Usage Guidelines3/5

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

'Much faster than exporting each doc' implies this is the bulk-search path over per-document export, but that comparison is against a workflow, not an alternative tool. There is no explicit guidance on when to choose this over find_doc_by_title or list_docs.

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

Deploy Server

Other Tools