List HelpCenter Article Notes
helpcenter_list_article_notesRead the private editorial notes the help-center's team has left on an article in the HelpCenter.io editor.
This is how you pick up human feedback on a draft: each note is anchored to a specific passage, so it tells you WHICH sentence to change, not just that something is wrong.
PRIVATE — these notes are written by the help-center's own team and are never shown to readers. Use them to decide what to change in the article. Do NOT quote or paraphrase a note into any reader-facing text: not into an article body, and never into helpcenter_reply_to_comment. A note may say precisely what the team has decided NOT to say publicly.
These are NOT reader comments. Visitor comments on the published article are a different tool (helpcenter_get_article_comments) and the two never return each other's content.
Args:
article_id (number, required): the article whose notes to read.
include_resolved (boolean, optional): also return threads already marked done. Off by default — the question this answers is what is still being asked of the draft.
lang (string, optional): language code; notes are per-language like the draft.
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { article, notes: [ { id, note, lang, anchor: { mark_id, quote, highlighted }, author, via, resolved, replies: [...] } ], meta: { threads_count, open_count, includes_resolved } }. anchor.highlighted is false once the passage was rewritten or deleted (quote still says what the note was about), or for a note that never had a highlight. via names the API key or app a note or reply came through, null for one written in the dashboard.
Errors: 403 'insufficient_scope' if the credential lacks the notes.read scope — content access does NOT imply it, and an API key holds it only if it was issued with it, so this is fixed by provisioning a new key, not by retrying. 403 'notes_forbidden' if the account behind the credential can no longer reach team comments in the dashboard. 404 if the article is not in this help center.
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_list_article_notes"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Language code — notes are per-language, like the draft they sit on. | |
| 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 notes to read. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |
| include_resolved | No | Also return threads already marked done. Off by default: the question this answers is what is still being asked of the draft. |