Skip to main content
Glama

Get an FAQ Section

helpcenter_get_faq_section
Read-onlyIdempotent

Read one FAQ section: its settings, its install snippet, and for a custom section the FAQs it lists in order, with whether each is shown to visitors (only published FAQ articles they may read are).

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

Args:

  • section_id (number, required): the section's id.

  • response_format ('markdown' | 'json'): default 'markdown'.

Returns: { faq_section: { ...as listed, articles: [ { id, title, status, type, position, shown } ] or null for a full section } }.

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": {
      "section_id": "<section_id>"
    },
    "name": "helpcenter_get_faq_section"
  }
}

Input Schema

NameRequiredDescriptionDefault
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.
section_idYesThe section's id (not its key).
response_formatNoOutput format: 'markdown' for a human-readable summary or 'json' for the full structured payload.markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds real value beyond that: the permission requirement and the rule that only published, readable FAQ articles are marked as shown. It stops short of describing what a 'full section' null-articles case means operationally.

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 purpose, then prerequisites, args and return shape in clearly labeled blocks. The Returns block earns its place given no output schema exists, though the sentence about published FAQ visibility is dense and slightly hard to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the explicit Returns shape is essential and is provided, along with auth requirements and optional-article semantics. The only gap is the unmentioned site_id, which matters for multi-help-center connections.

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 coverage is 100%, so the baseline is 3, but the description reinforces section_id's required status and the response_format default of 'markdown' in a compact Args block. It omits site_id entirely, which is the one parameter an agent could get wrong on a multi-site connection.

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?

The description opens with a specific verb and resource ('Read one FAQ section') and enumerates what comes back: settings, install snippet, and ordered FAQs with a 'shown' flag. The singular 'one' implicitly distinguishes it from helpcenter_list_faq_sections, though that sibling is never named.

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 states the access prerequisite ('Needs an editor, admin or owner of the help center'), which helps an agent decide whether the call can succeed. However, it gives no explicit when-to-use guidance versus list_faq_sections (enumerate vs fetch one) or update_faq_section, so the routing must be inferred.

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