Get HelpCenter Article Comments
helpcenter_get_article_commentsRead one article's comment conversation, threaded — replies nested under the comment they answer, to any depth.
Read-only. Use this when the question is about a specific article ("what are people confused about on the SSO page?"); use helpcenter_list_comments when it is about the help center as a whole.
PRIVACY — identical to helpcenter_list_comments:
Emails are REDACTED unless include_email is set (write-scoped key only); an absent 'email' does not mean the reader had none.
IP addresses are NEVER returned.
Internal team notes are excluded at EVERY nesting depth, so a thread can be shorter here than the team sees in the dashboard.
Args:
article_id (number, required): the article whose conversation to read.
status ('pending' | 'published' | 'unpublished' | 'deleted' | 'all', optional): default 'all'. Filters the WHOLE thread, not just its roots — asking for 'published' will not hand you a pending reply nested under an approved question.
lang (string, optional): language code. Also applies at every depth.
order ('asc' | 'desc', optional): default 'asc', oldest first — how a conversation reads.
include_email (boolean, optional): see PRIVACY above.
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { status, article: { id, title }, comments: [ { id, comment, author, status, replies: [...] } ], meta: { threads_count, comments_count } }. threads_count counts top-level comments; comments_count counts every comment in the thread.
Errors: 404 if the article id is not in this help center; 403 for include_email on a read-scoped key.
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": {
"article_id": "<article_id>"
},
"name": "helpcenter_get_article_comments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Language code to filter by. | |
| order | No | Thread order: 'asc' (default, oldest first — how a conversation reads) or 'desc'. | |
| status | No | Moderation state to filter by: 'pending' (awaiting approval — the queue), 'published' (visible to readers), 'unpublished' (rejected), 'deleted' (soft-deleted, excluded otherwise), or 'all' (default, everything except deleted). | |
| 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. | |
| article_id | Yes | Id of the article whose conversation to read. | |
| include_email | No | Include the commenter's email address. Off by default and deliberately so: these are readers' personal addresses, not the help center's data. Requires a WRITE-scoped key — a read-scoped key asking for it gets 403. Leave this off unless the task actually needs to contact someone. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |