Skip to main content
Glama

update_faq

DestructiveIdempotent

Modify an existing FAQ entry by supplying its ID, question, answer, and display order to keep your wedding FAQ list accurate and current.

Instructions

Update an existing FAQ — all three fields (question, answer, display_order) must be supplied

Input Schema

NameRequiredDescriptionDefault
answerYes
questionYes
display_orderYes
faq_entity_idYesFAQ entity ID from list_faqs

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

A3.5/5.0
Behavior4/5

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

Annotations already declare destructiveHint, idempotentHint and openWorldHint, so the safety profile is covered. The description adds meaningful context beyond them: it discloses that this is a full overwrite requiring every field, which explains why partial updates are impossible and complements the destructive hint.

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

Conciseness5/5

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

A single front-loaded sentence that states the action and the key constraint with zero filler. Nothing is duplicated or wasted.

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 simple four-parameter mutation with annotations covering safety, this is close to adequate; the full-replacement requirement is conveyed. However it omits sibling routing and any note on permissions or effect on the existing FAQ, leaving some gaps against the 25% schema coverage.

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 only 25% — just faq_entity_id is documented ('FAQ entity ID from list_faqs'). The description names the other three parameters and their mandatory/full-replacement nature, partially compensating, but adds no format or semantics for display_order or answer beyond the type in the schema.

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 and resource ('Update an existing FAQ'), clearly distinguishing it from list_faqs, add_faq and remove_faq without needing to name them. It does not explicitly route to those siblings, but the action is unambiguous.

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?

The description gives no when-to-use context, no prerequisites, and no mention of the alternative tools (add_faq, remove_faq) or when to prefer them. The 'all three fields must be supplied' constraint hints at full-replacement usage but is not framed as guidance.

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