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

Read-only tool

search_help_articles

Find public help articles by words in their title, summary, keywords or Markdown content.

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

Arguments

search_help_articles arguments
FieldTypeDescription
querystringWords to find. Omit or send an empty string to list all articles.

Search installation help

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": "search_help_articles",
    "arguments": {
      "query": "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.",
    "reviewed_at": "2026-10-31",
    "url": "https://www.attriboo.com/docs/installation",
    "markdown_url": "https://www.attriboo.com/docs/markdown/installation.md"
  }
]

Result fields

search_help_articles result fields
FieldTypeDescription
result[]arrayMatching article summaries.

result[][] fields

result[] nested 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.

All search words must match; matching is case-insensitive. Returns a list of slug, category, title, summary, reviewed_at, url and markdown_url.

Use a returned slug with get_help_article. Reviewed dates can be null. The response example illustrates the shape rather than a guaranteed current search result.

Full MCP result wrapper
MCP result object
{
  "content": [
    {
      "type": "text",
      "text": "[\n  {\n    \"slug\": \"installation\",\n    \"category\": \"installation\",\n    \"title\": \"Install Attriboo on your website\",\n    \"summary\": \"Choose the matching platform installation guide.\",\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  }\n]"
    }
  ]
}

Related documentation