Model Context Protocol Endpoints

HelpGuides exposes a set of Model Context Protocol (MCP) tools that allow AI assistants, agents, and large language models to read, create, and manage documentation programmatically. These tools are available via the MCP server endpoint for your HelpGuides project.

Available Tools

The following MCP tools are supported. Each tool has a defined name, purpose, and set of parameters.

Tool Name	Description
`get_instructions`	Returns usage instructions and workflow guidance. Always call this tool first before using any other MCP tools.
`search`	Searches for existing articles. Returns up to 25 results matching the query string.
`get_article`	Retrieves the full content of an article by post ID or full URL.
`create_article`	Creates a new article as a draft. Requires a title and HTML body.
`update_article`	Updates the title or HTML body of an existing article by post ID or full URL.
`publish_article`	Changes an article's status to Published by post ID or full URL.
`get_categories`	Returns all categories available in the project.
`set_category`	Assigns a category to an article by post ID or full URL.

Tool Reference

get_instructions

Always call get_instructions before using any other tool. It returns workflow guidance, content formatting rules, and best practices for working with HelpGuides via MCP.

search

Use search to find existing articles before creating new ones to avoid duplicates. Pass a query string and an optional limit (default 10, max 25). Results include the post ID, title, slug, status, and a content excerpt.

s — The search query string (required)
limit — Number of results to return (optional, default 10)

get_article

Retrieves the full title and HTML content of an article. Accepts either a post ID or the full URL of the article.

postuid_or_url — A post ID (e.g. abc123) or a full article URL (required)

create_article

Creates a new article as a draft. Articles are never published automatically — always create as draft and let the user review before publishing. The article slug is automatically derived from the title.

title — The article title (required)
html — The article body in HTML format (required)

update_article

Updates the title or body of an existing article. Either or both fields may be provided; omitting a field leaves it unchanged.

postuid_or_url — A post ID or full article URL (required)
title — Updated title (optional)
html — Updated HTML body (optional)

publish_article

Changes an article's status from Draft to Published. Only call this after the user has reviewed the draft.

postuid_or_url — A post ID or full article URL (required)

get_categories

Returns all categories configured in the project. Use this to look up category IDs before calling set_category.

set_category

Assigns a category to an article. Use get_categories first to find the correct category ID.

postuid_or_url — A post ID or full article URL (required)
categoryuid — The category ID to assign (required)

Recommended Workflow

Call get_instructions to load workflow guidance.
Call search to check for existing related articles.
Draft content and show it to the user for review.
Call create_article or update_article after user approval.
Call get_categories and set_category to assign the correct category.
Call publish_article only after the user has reviewed the draft on HelpGuides.

For more on how HelpGuides supports AI integrations, see Model Context Protocol and Using LLMS.txt.