Skip to main content
Glama

findGlossary

Public glossary of terms. title required in default-locale; synonyms (comma-separated) and title are both used for content auto-linking. shortDefinition (required, max 300 chars) is the citable, self-contained blurb shown in tooltips and picked up by AI answers — keep it independently understandable. definition is optional Lexical richText for a longer explanation. related links to other glossary entries; noAutolink: true opts a term out of automatic in-content linking. glossary 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: title (localized), slug (localized), synonyms (localized), shortDefinition (textarea, localized, required, ≤300 chars), definition (richText, localized), publishedAt (date), tags (rel-array: tags), related (rel-array: glossary), relatedFaqs (rel-array: faqs), noAutolink (boolean), robots (enum: index (Index (default))|noindex (noindex (hide))), searchText (textarea, localized, ≤60000 chars, redacted), meta (group: title, description, focusKeyword, secondaryKeyword1-4, searchIntent, eeatInsight, image — localized).

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": "findGlossary"
  }
}

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

B3/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the whole burden. It does disclose useful non-schema behavior: public read access via /api/agents, publish-workflow/draft semantics, localization, and a serialization warning about parallel writes. However, a large share of that disclosure (permanent hard deletes, deadlock retries, writing guidelines) concerns create/update/delete and is dead weight for a find call, and the read path's own behavior (return volume, pagination) is left unstated.

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

Conciseness1/5

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

It is a single dense block that front-loads shortDefinition guidance and buries the tool's actual read behavior, mixing field-by-field documentation, write-time warnings and operational caveats into one paragraph. Substantial portions (delete permanence, deadlock retry advice, the full field inventory) do not apply to invoking findGlossary and dilute the signal an agent needs.

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?

Against a 14-parameter schema that is fully self-described and no output schema, the description supplies the contextual layer the schema cannot: collection semantics, draft/publish state, localization, and public-read scope. What remains missing is find-specific query guidance, but the schema already documents those parameters in full, so the definition is complete enough to call 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 explains id, page, sort, depth, limit, where, select, populate and friends, making the baseline a 3. The description does add real meaning for two parameters: draft (published main-table vs versions table) and locale (fields are localized, with localization noted per field), but it says nothing about where, joins, populate or select beyond what the schema states.

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 opening line 'Public glossary of terms' identifies the resource, and 'MCP capabilities: find, create, update, delete' only implies this tool is the read side of the family. The description never states a verb such as 'retrieve/list glossary entries', and most of the text documents the collection's fields rather than what this call does, so an agent must infer the purpose from the name.

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?

There is one genuinely useful usage rule for this read tool: 'a find WITHOUT draft:true returns the published main-table state only', which tells the agent when to set the draft flag. The 'call getWritingGuidelines before writing' instruction is aimed at write operations and does not guide reads, and there is no statement of when to reach for findGlossary over the other find* siblings beyond the implicit resource name.

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