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.

Input Schema

TableJSON 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. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Discloses that operations affect the workspace's FAQ items and that they appear in the chat widget and are AI-usable. No annotations present, so description carries full burden; it lacks details on side effects (e.g., update is partial, deletion permanent) and idempotency.

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?

Two concise sentences: first defines scope, second maps actions to requirements. No fluff, front-loaded with purpose.

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?

Covers the four operations and their required parameters. Lacks return value descriptions (no output schema) and does not explain the enabled field or default behavior. Adequate for a CRUD tool but not comprehensive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 100% description coverage, so baseline is 3. The description adds value by explicitly mapping which parameters are required per action (e.g., 'create' needs question+answer), which is not fully captured in the schema's required array.

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

Purpose5/5

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

Clearly states it lists, creates, updates, or deletes FAQ items for the workspace. Distinguishes from sibling knowledge tools by specifying 'FAQ items (shown in the chat widget and usable by the AI agent)'.

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

Usage Guidelines4/5

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

Explicitly describes the four action values and their required parameters. No explicit when-not-to-use or alternatives, but the action enum and required fields provide clear usage guidance.

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.

TDQS

A4.1/5.0
Disambiguation4/5

Tools are largely distinct, with clear purposes for knowledge management, conversations, FAQs, and setup. The only potential overlap is between 'search' (general help) and 'search_knowledge' (workspace KB), but descriptions clarify the context.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., add_knowledge, list_conversations, manage_faq). No mixing of conventions or vague verbs.

Tool Count5/5

17 tools is well-scoped for a live-chat and AI agent workspace server. The set covers setup, knowledge base, conversations, FAQs, analytics, keywords, and embedding without being overwhelming.

Completeness4/5

The tool surface is comprehensive for core workspace management and support: setup, knowledge ingestion/search, conversation handling, FAQs, analytics, and keywords. Minor gaps like user management or advanced channel configuration, but nothing that critically hinders agent workflows.

Resources