HelpCenter.io

List FAQ Sections

helpcenter_list_faq_sections

Read-onlyIdempotent

List the help center's embeddable FAQ sections (blocks of FAQs placed on the user's own website), and the templates a section can take.

Read-only. Needs an editor, admin or owner of the help center.

Args:

type ('custom' | 'full', optional): only sections of this type.
response_format ('markdown' | 'json'): default 'markdown'.

Returns: { faq_sections: [ { id, key, type, title, description, display_urls, template, design, show_heading, layout, has_custom_css, article_count, install_snippet, created_at, updated_at } ], templates: { ids, default, classic, design } }.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "helpcenter_list_faq_sections"
  }
}

Input Schema

Name	Required	Description	Default
`type`	No	Only sections of this type.
`site_id`	No	Which 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.
`response_format`	No	Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload.	markdown

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 4, 2026

TDQS

A3.8/5.0

Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, yet the description adds the required permission level and clarifies what an FAQ section actually is in this product. The Returns block enumerates the exact payload shape (including install_snippet and has_custom_css), which is meaningful behavioral disclosure absent an output schema.

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?

Front-loaded with the core purpose, followed by a compact auth note and separate Args/Returns blocks. The Args block largely duplicates schema text, which is the only wasted space; the Returns block earns its place.

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 a read-only list tool with no output schema, the description supplies the return structure field-by-field, the permission requirement, and the domain meaning of an FAQ section. The only omission, site_id handling, is thoroughly covered in the schema itself.

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 100%, so all three parameters — including the multi-help-center site_id rule — are already fully documented in the schema. The description's Args section only restates 'type' and 'response_format' and silently omits site_id, adding no meaning beyond the schema; the 100% coverage baseline of 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 and resource ('List the help center's embeddable FAQ sections') and even defines the concept as blocks of FAQs placed on the user's own website, plus the secondary output of available templates. It is clearly distinguishable from get_faq_section, create_faq_section and list_articles, though it does not name any sibling explicitly.

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?

Provides a prerequisite ('Needs an editor, admin or owner of the help center') and states it is read-only, which is genuinely useful context. However it never says when to prefer this over helpcenter_get_faq_section for a single section or helpcenter_list_sites for the help center itself, so the routing guidance is only implied.

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

All HelpCenter.io tools Inspect

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

Need Help?