Skip to main content
Glama

add_faq

Add a new FAQ question and answer to a Zola website FAQ page, with an optional display order to set its position in the list.

Instructions

Add a new FAQ (question + answer) to the website FAQ page

Input Schema

NameRequiredDescriptionDefault
answerYesThe FAQ answer
questionYesThe FAQ question
display_orderNoPosition in the FAQ list (defaults to 0)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observedv1.4.2

TDQS

C2.9/5.0
Behavior2/5

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

Annotations declare destructiveHint=false and openWorldHint=true, but the description adds no behavioral context beyond that: it does not say whether the FAQ publishes immediately, how it interacts with display_order/defaults, or whether permissions or moderation apply. For a write operation with only partial annotation coverage, this is thin.

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?

A single front-loaded sentence with no padding or redundancy. It is appropriately sized, though its brevity stems partly from saying less than it could rather than from dense information.

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?

With fully documented params and a safety annotation present, the core facts needed to invoke the tool are covered. However, for an add/mutation tool with no output schema, the description omits what happens on success (e.g., where the FAQ appears, whether it is immediately live), leaving a modest gap.

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 question, answer and display_order (including its default of 0) are already fully documented. The description only restates question+answer and adds no format, length, or ordering semantics, so baseline 3 applies.

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 (add) and resource (FAQ = question + answer) and scopes it to the website FAQ page. It is distinguishable from siblings like update_faq, remove_faq and list_faqs by name, though the description never explicitly contrasts them.

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 no guidance on when to use this versus update_faq or list_faqs, no prerequisites, and no mention of when a FAQ should be added rather than modified. An agent must infer usage entirely from the tool name.

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