Skip to main content
Glama
Sign In

HelpCenter.io

by io.helpcenter
OverviewDiscussionsAdmin

Create an FAQ Section

helpcenter_create_faq_section

Create an embeddable FAQ section for the user's website. A 'custom' section starts empty: add FAQ articles to it next. A 'full' section lists every published FAQ article, grouped by category. It starts on the 'slate' template unless template names another (see helpcenter_list_faq_sections). Place the section's install_snippet where it should appear, on a page that also carries the widget snippet (helpcenter_get_widget_install) and whose host is in the section's display_urls.

Nothing shows anywhere until its snippet is placed. Needs an admin or owner of the help center.

Args:

  • type ('custom' | 'full', required).

  • title (string or { language: text }, required): the heading.

  • description (string or { language: text }, optional).

  • display_urls (string[], optional): hosts of the pages that will carry it.

  • template (string, optional), design (object, optional), show_heading (boolean, optional).

Returns: { faq_section } with its id and install_snippet.

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": {
      "type": "<type>",
      "title": "<title>"
    },
    "name": "helpcenter_create_faq_section"
  }
}

Input Schema

NameRequiredDescriptionDefault
typeYes'custom' lists the FAQs you add, in your order. 'full' lists every published FAQ article, grouped by category.
titleYesThe heading: text in the help center's default language, or text by language, e.g. {"default": "Billing questions", "fr": "Questions de facturation"}.
designNoDesign tokens the template reads; any left out take the template's own. Replaces the stored design when sent.
site_idNoWhich help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say.
templateNoA template id from helpcenter_list_faq_sections (templates.ids), e.g. 'slate', 'beacon', 'glass'. 'classic' is the plain renderer.
descriptionNoOptional text under the heading, in the same form as title.
display_urlsNoHost names of the pages that will carry the section, e.g. ['www.example.com'], compared exactly (www.example.com and example.com are two). A URL is reduced to its host. The help center's own domain always works.
show_headingNoWhether the section shows its title.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only tell the agent this is a non-read-only, non-destructive, non-idempotent open-world write; the description adds the behavior that actually matters: nothing is visible until the snippet is placed, the default template is 'slate' unless overridden, and admin/owner privileges are required. The 'custom' vs 'full' content-population semantics are also disclosed, which is a real behavioral difference not captured by the type enum alone.

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?

Structure is well front-loaded: purpose, then mode semantics, then deployment mechanics, then Args/Returns. The Args block is somewhat redundant given 100% schema description coverage, but it is short, grouped, and the Returns line compensates for the absent output schema.

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?

For an 8-parameter creation tool with a nested design object and no output schema, the description covers the multi-step workflow (create → add articles → place snippet), the permission gate, the template default, and the return shape (faq_section with id and install_snippet). There is no output schema to lean on, and the description supplies that information itself.

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 description coverage is 100%, so the baseline is 3 and the Args list is largely a restatement of the schema. It earns the bump by adding relational meaning the schema cannot: template defaults to 'slate' and must come from helpcenter_list_faq_sections, and display_urls must include the host of the page hosting the install_snippet — a cross-parameter invariant. Minor params (design, show_heading, description) get no elaboration beyond the schema, which keeps it from a 5.

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?

The first sentence states a specific verb and resource ("Create an embeddable FAQ section") and immediately disambiguates the two modes: 'custom' starts empty, 'full' lists every published article grouped by category. That distinction plus the named references to helpcenter_list_faq_sections and helpcenter_add_faq_section_articles lets an agent place this tool relative to its siblings without opening any schema.

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

Usage Guidelines5/5

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

It gives explicit sequencing (a 'custom' section starts empty, "add FAQ articles to it next"), names two prerequisite tools (helpcenter_list_faq_sections for template ids, helpcenter_get_widget_install for the widget snippet), and states the deployment precondition — the section's install_snippet must be placed on a page carrying the widget snippet whose host is in display_urls. The permission requirement ("admin or owner") is also stated, so there is nothing left to infer about when this tool is the right call.

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

All HelpCenter.io toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources