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). Write ONE document at a time: wait for the response of each create/update/delete call before sending the next — parallel writes can fail with a database deadlock (HTTP 500, nothing saved; retry that call alone). Before writing public text here, call getWritingGuidelines with this collection and the locale (brand voice, writing rules, fixed terms, SEO rules, taken keywords, field rules). Fields: question (localized, required), answer (richText, localized, required), categories (rel-array: faq-categories), publishedAt (date), searchText (textarea, localized, ≤60000 chars, redacted).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "findFaqs"
  }
}

Input 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.
joinsNoOptional: configure join field queries, or pass false to disable all join fields.
limitNoMaximum number of documents to return (default: 10, max: 100)
trashNoOptional: include soft-deleted documents when trash is enabled on the collection
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, e.g., {"title": true}
populateNoOptional: control which fields to include from populated relationship or upload documents.
paginationNoOptional: set to false to skip the count query overhead
fallbackLocaleNoOptional: fallback locale code to use when requested locale is not available

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • addedInput schema / properties / joins
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": {},
      +      "type": "object"
      +    },
      +    {
      +      "const": false,
      +      "type": "boolean"
      +    }
      +  ],
      +  "description": "Optional: configure join field queries, or pass false to disable all join fields."
      +}
    • addedInput schema / properties / pagination
      Added value: +{
      +  "description": "Optional: set to false to skip the count query overhead",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / populate
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "Optional: control which fields to include from populated relationship or upload documents.",
      +  "type": "object"
      +}
    • addedInput schema / properties / select / additionalProperties
      Added value: +{}
    • changedInput schema / properties / select / description
      Previous value: -"Optional: define exactly which fields you'd like to return in the response (JSON), e.g., '{\"title\": true}'"New value: +"Optional: define exactly which fields you'd like to return in the response, e.g., {\"title\": true}"
    • changedInput schema / properties / select / type
      Previous value: -"string"New value: +"object"
    • addedInput schema / properties / trash
      Added value: +{
      +  "description": "Optional: include soft-deleted documents when trash is enabled on the collection",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

C2.9/5.0
Behavior4/5

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

With no annotations, the description carries the full load and does disclose real behavior: a find without draft:true returns only the published main-table state, public read is exposed via /api/agents, and, notably, MCP deletes are permanent hard-deletes that bypass Trash. It also warns about write deadlocks requiring serial calls, though much of that pertains to create/update/delete rather than this read tool.

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 text is a dense run-on that mixes field requirements, page/block usage, write workflow, and delete warnings into one block, and it is not front-loaded with a clear purpose statement. A large fraction of the sentences are irrelevant to a find operation, so they do not earn their place.

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?

For a 14-parameter find tool with full schema coverage and no output schema, the description covers the critical drafts subtlety that the schema cannot convey. However, it omits how results are shaped (pagination, populate depth, relationship expansion) and spends much of its budget on write/delete behavior irrelevant to invoking this tool.

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 all 14 parameters, and the baseline is a 3. The description adds genuine meaning only for the draft flag ('a find WITHOUT draft:true returns the published main-table state only') and mentions an _status:'published' filter that is not actually a schema parameter, while the other 13 params get no added context.

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

Purpose3/5

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

The description opens with the fragment 'FAQ entries' rather than a verb+resource statement, so an agent must infer that this retrieves FAQ documents from the name and the surrounding collection talk. The line 'MCP capabilities: find, create, update, delete' further muddies the purpose, since this tool is find-only and the create/update/delete language belongs to a different operation.

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

Usage Guidelines2/5

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

There is related-tool guidance ('schedule a future date via the schedulePost tool', 'call getWritingGuidelines ... before writing public text'), but nothing states when to choose findFaqs itself or when not to. No exclusions or prerequisites for the find operation are given, so selection guidance is largely absent.

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