Help Tools | Yaplet

Overview

The Help tool category handles your public-facing help content — both Knowledge Bases (HTML articles for customer-facing help centers) and Documentation (Markdown pages for technical/developer portals). You can create content manually or with AI assistance, organize it into categories, and control publishing. Published content is automatically indexed for AI retrieval.

Permission required:Copilot.Help

Knowledge Base Tools

manage_knowledgebase

Unified tool for managing knowledge bases, their categories, and articles. Uses an action parameter to select the operation.

Actions

Action	Description	Required Params
`create`	Create a knowledge base portal	`name`
`update`	Update a knowledge base portal	`id`
`create_category`	Create a category inside a KB	`knowledgebaseId`, `name`
`update_category`	Update a category	`id`
`create_article`	Create an article (HTML)	`knowledgebaseId`, `title`, + `content` or `generateContent`
`update_article`	Update an article	`id`

Parameters

Parameter	Type	Used by	Description
`action`	string	All	The operation to perform
`id`	string	update, update_category, update_article	Target ID
`knowledgebaseId`	string	create_category, create_article	Parent knowledge base ID
`name`	string	create, create_category, update, update_category	KB portal or category name
`language`	string	create, update, create_article, update_article	Content language (default `"en"`)
`description`	string or null	create_category, update_category	Category description
`parentId`	string or null	create_category, update_category	Parent category ID for nesting
`position`	number	create_category, update_category, create_article, update_article	Sort position (0-based). Auto-assigned to end if omitted. If taken, existing items shift down.
`title`	string	create_article, update_article	Article title. Auto-generates a URL slug.
`content`	string	create_article, update_article	HTML content for articles
`generateContent`	string	create_article, update_article	Describe the article and AI generates the HTML. Mutually exclusive with `content`.
`published`	boolean	create_article, update_article	Publish status. Defaults to `false` on create. Changing triggers the embedding pipeline.
`categoryId`	string or null	create_article, update_article	Category to assign the article to. Pass `null` to unassign.

How It Works

Knowledge base portal: A container that holds categories and articles. Create with a name, update to rename or change language.

Categories: Organize articles into sections. Supports hierarchical nesting via parentId. Slug is auto-generated from the name.

Articles: Written in HTML. Support AI content generation via generateContent. Slugs are auto-generated from titles.

Publishing & AI indexing:

Publishing an article triggers automatic AI/RAG indexing so chatbots can reference it.
Unpublishing removes the AI index entry.
Updating content on a published article automatically re-indexes it.

Example Prompts

"Create a knowledge base called Help Center."
"Create a knowledge base in Hungarian called Sugo."
"Rename my knowledge base to Customer Support Docs."
"Create a category called Getting Started in my Help Center."
"Create an article titled 'Getting Started' with content about how to set up an account."
"Write an article about our refund policy — generate the content with AI."
"Publish my Getting Started article."
"Move the Billing FAQ article to the Account Management category."

Documentation Tools

manage_documentation

Unified tool for managing documentation portals, categories, and pages. Uses an action parameter to select the operation. Publishing is handled separately by publish_documentation.

Actions

Action	Description	Required Params
`create`	Create a documentation portal	`title`
`update`	Update a documentation portal	`id`
`create_category`	Create a category	`documentationId`, `name`
`update_category`	Update a category	`id`
`create_page`	Create a page (Markdown)	`documentationId`, `title`, `categoryId`, + `content` or `generateContent` (unless `isGroup`)
`update_page`	Update a page	`id`

Parameters

Parameter	Type	Used by	Description
`action`	string	All	The operation to perform
`id`	string	update, update_category, update_page	Target ID
`documentationId`	string	create_category, create_page	Parent documentation ID
`title`	string	create, create_page, update, update_page	Documentation or page title
`language`	string	create, update	Content language (default `"en"`)
`name`	string	create_category, update_category	Category name
`description`	string or null	create_category, update_category, create_page, update_page	Description
`content`	string	create_page, update_page	Markdown content
`generateContent`	string	create_page, update_page	AI generates Markdown. Mutually exclusive with `content`.
`categoryId`	string	create_page, update_page	Category assignment. Required for create_page.
`parentId`	string or null	create_page, update_page	Parent page for hierarchical nesting
`isGroup`	boolean	create_page, update_page	Structural group page (no content needed). Defaults to `false`.
`position`	number	create_category, update_category, create_page, update_page	Sort position (0-based). Auto-assigned to end if omitted. If taken, existing items shift down.

How It Works

Documentation portal: A container that holds categories and pages. Create with a title, update to rename or change language.

Categories: Organize pages into sections. Slug is auto-generated from name. New categories are created unpublished — use publish_documentation to publish them.

Pages: Written in Markdown. Support AI content generation, hierarchical nesting via parentId, and structural groups (isGroup). Slugs are auto-generated from titles. New pages are created unpublished.

Note: This tool does not handle publishing. Use publish_documentation to publish or unpublish categories and pages.

Example Prompts

"Create a documentation called Developer Docs."
"Create a category called Getting Started in my documentation."
"Create a documentation page about our REST API endpoints."
"Generate a getting started guide for developers using our SDK."
"Create a group page called 'Guides' and add two child pages under it."
"Update the authentication page with the new OAuth flow details."
"Reorder the API Reference page to position 0 (first)."

publish_documentation

Publishes or unpublishes documentation categories or pages. Handles dependency validation and recursive operations.

Parameters

Parameter	Type	Required	Description
`type`	string	Yes	What to publish: `"category"` or `"page"`
`id`	string	Yes	Category or page ID
`published`	boolean	Yes	`true` to publish, `false` to unpublish

How It Works

Publishing rules:

Category publish: Embeds all already-published pages in the category for AI retrieval.
Category unpublish: Sets all pages in the category to unpublished and removes their AI index entries.
Page publish: Requires the parent page (if any) AND the category to be published first. Embeds the page for AI retrieval.
Page unpublish: Recursively unpublishes all child pages and removes their AI index entries.

Example Prompts

"Publish the Getting Started category."
"Unpublish the old API v1 category and all its pages."
"Publish the authentication page."
"Unpublish the deprecated endpoints page and its children."

Common Workflow Patterns

Build a Complete Help Center (Knowledge Base)

Create the knowledge base → manage_knowledgebase with action: "create"
Organize with categories → manage_knowledgebase with action: "create_category"
Write articles → manage_knowledgebase with action: "create_article" + generateContent
Publish articles → manage_knowledgebase with action: "update_article" + published: true
Link to widget → link_to_widget (from Widget tools)

Build Developer Documentation

Create the documentation → manage_documentation with action: "create"
Create categories → manage_documentation with action: "create_category"
Write pages → manage_documentation with action: "create_page" + generateContent
Organize hierarchy → manage_documentation with action: "create_page" + parentId
Publish categories → publish_documentation with type: "category"
Publish pages → publish_documentation with type: "page"
Link to widget → link_to_widget (from Widget tools)