Create HelpCenter Article Note
helpcenter_create_article_noteLeave a private editorial note on a passage of an article — "Changed this in the 4.2 pricing: Growth and up." The note is highlighted on that passage in the HelpCenter.io editor, so a reviewer finds what you changed, and why, in place.
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.
Notes you leave are PRIVATE too: the team reads them in the editor, readers never see them, and placing one is not an edit — no revision, no staged change, nothing a reader sees. The note is attributed to the account the credential authenticates as; there is no author field.
Quote the passage as PLAIN TEXT exactly as it reads in the article — not Markdown, not HTML — and long enough to occur only once. You never name a mark id: the server looks for the passage in that language's staged copy (if there is one) and in the live article, and highlights it in every copy that holds it exactly once. It is matched on its text alone, so whitespace, line breaks and entities do not matter, and a passage may cross bold text, links and paragraphs.
This tool is for a passage already in the article. To note a change in the call that makes it, pass notes or annotate_changes to helpcenter_update_article or helpcenter_stage_article_changes instead.
Needs the notes.write scope, which is separate from content access: an API key holds it only if it was issued with it.
NOT IDEMPOTENT: calling this twice leaves two notes. Read the notes back with helpcenter_list_article_notes before retrying.
Args:
article_id (number, required): the article to leave the note on.
quote (string, required, up to 5000 characters): the passage, plain text, exactly as it reads.
note (string, required): 1-5000 characters, plain text — what you changed and why, or what the team should look at.
lang (string, optional): the language whose text the passage is in, one of the help center's languages. Defaults to the help center's default language.
Returns: { status: "success", message: "Note added.", note: { id, article_id, lang, note, anchor: { mark_id, quote, highlighted }, author, via, resolved, replies } }. author is the account behind the credential ("AI agent (setup)" for an AI agent's key); via names the API key or app the note came through. anchor.highlighted is false when another open note already highlights the whole passage: the note is still on the article.
Errors: 422 'note_quote_not_found' — the passage is in neither the staged copy nor the live article: re-read the article (helpcenter_get_article, or helpcenter_get_staged_changes for the staged copy) and quote it exactly as it reads. 422 'note_quote_ambiguous' — it occurs more than once (occurrences says how often): quote more of the surrounding text. Nothing is written on either. 403 'insufficient_scope' without the notes.write scope — fixed by provisioning a key or connection that holds it, not by retrying; 403 'notes_forbidden' or 'role_forbidden' if the account behind the credential cannot reach team notes in the dashboard; 404 if the article is not in this help center, or is private to other people.
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>",
"quote": "<quote>",
"note": "<note>"
},
"name": "helpcenter_create_article_note"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Language code of the text the passage is in — one of the help center's languages. Defaults to the help center's default language. | |
| note | Yes | The note, 1-5000 characters, plain text: what you changed and why, or what the team should look at. PRIVATE — the team reads it in the editor; readers never see it. | |
| quote | Yes | The passage the note is about, as PLAIN TEXT exactly as it reads in the article — not Markdown, not HTML — and long enough to occur only once. Up to 5000 characters. | |
| 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 to leave the note on. |