Skip to developer documentation
Browse developer documentation
MCP documentation / Help and releases

Read-only tool

get_help_article

Retrieve one complete help article as Markdown using a returned slug.

Access: OAuth analytics:read or a privately configured workspace key.

Arguments

get_help_article arguments
FieldTypeDescription
slugRequiredstringExact article slug returned by search_help_articles.

Read an installation guide

Use this JSON-RPC call through an initialized MCP client. Replace example values with your actual website, dates or confirmed setup details.

MCP tools/call request
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_help_article",
    "arguments": {
      "slug": "installation"
    }
  }
}

Decoded result

Illustrative JSON parsed from the result’s text block.

Decoded JSON result
{
  "slug": "installation",
  "category": "installation",
  "title": "Install Attriboo on your website",
  "summary": "Choose the matching platform installation guide.",
  "content_markdown": "# Install Attriboo on your website\n\nThe complete guide is returned here.",
  "reviewed_at": "2026-10-31",
  "url": "https://www.attriboo.com/docs/installation",
  "markdown_url": "https://www.attriboo.com/docs/markdown/installation.md"
}

Result fields

get_help_article result fields
FieldTypeDescription
slugstringExact help article slug.
categorystringHelp category identifier.
titlestringArticle title.
summarystringShort description.
reviewed_atstring | nullReviewed date or null; not a fabricated modification timestamp.
urlstringCanonical public HTML page.
markdown_urlstringPublic Markdown URL.
content_markdownstringFull article Markdown, with code, tables, images and links preserved.

Returns slug, category, title, summary, content_markdown, reviewed_at, url and markdown_url. The Markdown example is shortened for readability; actual content_markdown contains the full guide.

An unknown slug returns isError: true with a readable message. Help content is also available publicly through the HTML and Markdown help pages.

Full MCP result wrapper
MCP result object
{
  "content": [
    {
      "type": "text",
      "text": "{\n  \"slug\": \"installation\",\n  \"category\": \"installation\",\n  \"title\": \"Install Attriboo on your website\",\n  \"summary\": \"Choose the matching platform installation guide.\",\n  \"content_markdown\": \"# Install Attriboo on your website\\n\\nThe complete guide is returned here.\",\n  \"reviewed_at\": \"2026-10-31\",\n  \"url\": \"https://www.attriboo.com/docs/installation\",\n  \"markdown_url\": \"https://www.attriboo.com/docs/markdown/installation.md\"\n}"
    }
  ]
}

Related documentation