Skip to main content
Glama

findFaqs

FAQ entries. Both question (text) and answer (richText) required. Link to faq-categories via categories: [id]. Used by /faq system page + faqBlock. Has drafts: use _status:"published" to go live (draft stays hidden); schedule a future date via the schedulePost tool (collection "faqs"). faqs collection. Drafts: yes (publish workflow; a find WITHOUT draft:true returns the published main-table state only). Public read: yes via /api/agents. MCP capabilities: find, create, update, delete. ⚠ delete is PERMANENT (hard-delete; the admin Trash does NOT catch MCP deletes). Fields: question (localized, required), answer (richText, localized, required), categories (rel-array: faq-categories), publishedAt (date), searchText (textarea, localized, ≤60000 chars, redacted).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoOptional: specific document ID to retrieve. If not provided, returns all documents
pageNoPage number for pagination (default: 1)
sortNoField to sort by (e.g., "createdAt", "-updatedAt" for descending)
depthNoHow many levels deep to populate relationships (default: 0)
draftNoOptional: Whether the document should be queried from the versions table/collection or not.
limitNoMaximum number of documents to return (default: 10, max: 100)
whereNoOptional JSON string for where clause filtering (e.g., '{"title": {"contains": "test"}}')
localeNoOptional: locale code to retrieve data in (e.g., "en", "es"). Use "all" to retrieve all locales for localized fields
selectNoOptional: define exactly which fields you'd like to return in the response (JSON), e.g., '{"title": true}'
fallbackLocaleNoOptional: fallback locale code to use when requested locale is not available

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior5/5

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

With no annotations provided, the description bears the full burden and does an excellent job. It discloses draft behavior (find without draft:true returns only published state), public read access via /api/agents, the full MCP capability set (find, create, update, delete), and a strong warning that delete is hard-delete not caught by the admin Trash. It also notes field constraints like localization and character limits. No contradictions with annotations (none exist).

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

Conciseness2/5

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

The description is a single, dense run-on paragraph of about 200 words, mixing resource fields, workflow notes, and warnings without clear segmentation. It front-loads with 'FAQ entries' but then cascades into many semicolon-separated points that are hard to parse quickly. It could be broken into bullet points or sections for better scannability. It is not concisely structured.

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

Completeness3/5

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

Given there is no output schema, the description should clarify return shape or pagination behavior. While it covers many operational aspects (drafts, permissions, delete), it does not describe the response format (e.g., array of documents, fields included) or how pagination parameters interact with results. Since the schema covers parameter semantics, the missing piece is the output contract. The description is not fully complete for a complex find tool with 10 parameters.

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?

The input schema has 100% description coverage for all 10 parameters, providing baseline explanations for each. The description adds meaningful context for the `draft` parameter (explaining that without draft:true it returns only the published state) and implicitly ties `where` filtering to the field descriptions. However, it does not add significant detail for other parameters such as `page`, `limit`, or `sort`, which remain schema-defined. This meets the baseline but does not elevate beyond it.

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 clearly identifies the resource as 'FAQ entries' and elaborates on the exact fields (question, answer, categories) and its usage in the /faq system page and faqBlock. It also names the collection ('faqs') and lists the MCP capabilities. This is specific enough to distinguish it from siblings like findPages or findPosts without ambiguity.

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?

The description provides practical usage context: it explains the draft/publish workflow, the need to use `_status:"published"` for live content, the existence of the `schedulePost` tool for future dates, and the permanent delete warning. However, it does not explicitly state when to use this tool versus alternative find tools (e.g., 'use for FAQ content only'), nor does it compare to siblings. This is adequate but not explicit routing.

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