Skip to main content
Glama

Manage FAQ

manage_faq

List, create, update, or delete this workspace's FAQ items (shown in the chat widget and usable by the AI agent). Set action to 'list' | 'create' | 'update' | 'delete'. 'create' needs question + answer; 'update' and 'delete' need id.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "action": "<action>"
    },
    "name": "manage_faq"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoFAQ item id. Required for 'update' and 'delete'.
actionYesWhich FAQ operation to run.
answerNoAnswer text. Required for 'create'; optional for 'update'.
enabledNoWhether the FAQ item is visible/active. Optional for 'create' and 'update'.
questionNoQuestion text. Required for 'create'; optional for 'update'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / question / maxLength
      Previous value: -500New value: +200
  2. First observed

TDQS

B3.4/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 full behavioral burden. It usefully discloses the user-visible effect ('shown in the chat widget and usable by the AI agent'), which tells the agent that writes are customer-facing, but it says nothing about permissions, whether 'delete' is permanent, or what 'list' returns.

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?

Three compact sentences, front-loaded with the action enumeration and followed by per-action parameter requirements. Some phrasing duplicates the schema, but nothing is wasted or buried.

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 five-parameter, multi-action mutation tool with no annotations and no output schema, the description covers the action space and required fields but leaves return shape, error behavior, and permissions unaddressed. That is adequate but not complete.

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%, and the schema already labels each parameter with its per-action requiredness. The description restates 'create' needs question+answer and 'update'/'delete' need id, adding no meaning beyond the structured field. 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 set and resource: 'List, create, update, or delete this workspace's FAQ items,' and adds where those items surface (chat widget, AI agent). That distinguishes it from generic knowledge tools, though it never explicitly contrasts itself with siblings like add_knowledge or list_knowledge.

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?

It gives clear intra-tool routing via the 'action' enum and which parameters each action requires, which is genuine usage guidance for invoking it. It offers no guidance on when to reach for this tool versus the knowledge-base siblings, so the agent must infer that boundary.

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