Integration

ClickHelp integration

ClickHelp is a documentation authoring and publishing platform. Search a portal, read, create, update and delete topics and table-of-contents nodes, create, import, back up, publish and export projects (long jobs answer with a task key to follow with get_task_status), change publication visibility, manage files in the portal Storage (base64), users, workflow statuses and transitions, read topic-view and search-query reports, and ask AnswerGenius, the portal's AI assistant. Not exposed: user login tokens, portal and home-page appearance settings, chunked (resumable) and multipart file uploads, and FTP export targets. Authentication is HTTP Basic with your ClickHelp login and an API key from your profile (only Contributors can create one; the portal needs the REST API & MCP add-on or the API & Extensibility module); portal_domain is your portal's host, such as hedronlabs.clickhelp.co or your custom domain.

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in ClickHelp.Built from the 48 ClickHelp tools below, on the connection you add once.

What you can do with ClickHelp

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Article, 7 operations

  • create_topicCreate topicPOSTCreates a topic in a project with its id, title, HTML body, workflow status, owner and assignee, and places it in the table of contents (parentTocNodeId, tocNodeOrdinalNo).
  • delete_topicDelete topicDELETEDeletes one topic from a project.
  • delete_topicsDelete topicsDELETEDeletes several topics from a project in one call (ids).
  • get_topicGet topicGETReturns one topic with its HTML body and its compiled content as html or md (format), title, workflow status, owner, assignee, index keywords, TOC node and URL.
  • get_topic_views_reportGet topic views reportGETReports which topics a portal user (or anonymous readers, with user-login -) viewed between startDate and endDate, with the time, action and referrer of each view. Personal data.
  • list_topicsList topicsGETLists the topics of a project or publication (id, title, status, owner, assignee, TOC node, URL, dates); q runs a full-text search inside it, count limits the results (top 10 by default).
  • update_topicUpdate topicPATCHUpdates a topic's title, HTML body, workflow status, owner, assignee or index keywords. List every field to change in updatedFields: fields not listed are ignored.

Node, 6 operations

  • create_toc_node_folderCreate toc node folderPOSTCreates a folder node in a project's table of contents, under parentId (or at the root level when parentId is omitted), at position ordinalNo (the end by default).
  • delete_toc_nodeDelete toc nodeDELETEDeletes one table-of-contents node from a project.
  • delete_toc_nodesDelete toc nodesDELETEDeletes several table-of-contents nodes of a project, together with the topics linked to them.
  • get_toc_nodeGet toc nodeGETReturns one table-of-contents node: caption, parent, position, linked topic and whether it shows in publications.
  • list_toc_nodesList toc nodesGETLists the table-of-contents nodes of a project: id, caption, parent, position, linked topic and whether it shows in publications. isRootNodesOnly keeps the top level only.
  • update_toc_nodeUpdate toc nodePATCHChanges a table-of-contents node's caption, parent, position or visibility in publications. List every field to change in updatedFields: fields not listed are ignored.

Project, 6 operations

  • change_publication_visibilityChange publication visibilityPATCHChanges a live publication's visibility: Public (open to everyone), Restricted (chosen Power Readers and Contributors after login) or Private (Contributors only, hides it from readers). Send updatedFields: visibility.
  • create_projectCreate projectPOSTCreates a project, empty, from a template, or as a copy of an existing project (sourceType). Returns a taskKey to follow with get_task_status.
  • delete_projectDelete projectDELETEDeletes a project or publication; a deleted publication is gone for its readers and cannot be restored, and its translation publications are deleted with it. Returns a taskKey to follow with get_task_status.
  • get_projectGet projectGETReturns one project or publication with its title, language, visibility, URL, number of topics and last content change.
  • list_projectsList projectsGETLists the projects and publications the API user can access: id, title, language, visibility, parent project and full URL. types filters to Project or Publication; parentId lists the publications of one project.
  • list_user_projectsList user projectsGETLists the projects and publications one portal user can access.

Status, 5 operations

  • create_workflow_statusCreate workflow statusPOSTCreates a topic workflow status (Draft, Review or Ready type); translation statuses cannot be created here.
  • delete_workflow_statusDelete workflow statusDELETEDeletes a workflow status by its name; translation statuses cannot be deleted here.
  • get_workflow_statusGet workflow statusGETReturns one workflow status by its name: type, color, description and whether it is a translation status.
  • list_workflow_statusesList workflow statusesGETLists the portal's topic workflow statuses (name, type Draft, Review, Ready or Translation, color, description); isTranslation filters translation statuses.
  • update_workflow_statusUpdate workflow statusPATCHRenames a workflow status or changes its type, color or description; translation statuses cannot be changed here.

Storage, 5 operations

  • create_storage_fileCreate storage filePOSTCreates a file in the portal Storage from base64 content (best under 5 MB), or a folder with isFolder true. isOverwrite replaces an existing file.
  • delete_storage_fileDelete storage fileDELETEDeletes one file from the portal Storage.
  • delete_storage_filesDelete storage filesDELETEDeletes several files from the portal Storage in one call; each path starts with Storage/.
  • get_storage_filesGet storage filesGETReads the portal Storage: one file's details and, with format base64, its content; or the files of a folder matching filter (* for all, *.png...), recursively with isRecursive; or a folder's details.
  • update_storage_fileUpdate storage filePATCHReplaces the content of an existing file in the portal Storage with new base64 content (send updatedFields: content).

User, 5 operations

  • create_userCreate userPOSTCreates a portal account for a real person (a Power Reader by default, or a Contributor with a role). ClickHelp may email them about the new account; isDontSendEmail controls that email.
  • get_userGet userGETReturns one portal user's profile: name, email, type, role, culture and time zone, last activity and whether the account is enabled. Personal data.
  • list_project_usersList project usersGETLists the users who can access a project or publication, with login, name, email, type, role and whether the account is enabled. Personal data.
  • list_usersList usersGETLists every user of the portal with login, name, email, type (Contributor or Power Reader), role and whether the account is enabled. Personal data.
  • update_userUpdate userPATCHChanges a portal user's email, type, role, or enables or disables the account. List every field to change in updatedFields: fields not listed are ignored.

Transition, 3 operations

  • create_workflow_transitionCreate workflow transitionPOSTAllows topics to move from one workflow status to another by creating a transition between two non-translation statuses.
  • delete_workflow_transitionDelete workflow transitionDELETEDeletes a workflow transition by its id, as returned by list_workflow_transitions.
  • list_workflow_transitionsList workflow transitionsGETLists the allowed transitions between topic workflow statuses (id, source status, destination status).

Import, 2 operations

  • import_new_projectImport new projectPOSTCreates a project by importing a Word, RTF, EPUB, ODT, HTML, Markdown, DocFX, OpenAPI (AutoDocs) or project-backup file, from a URL or base64 content. Returns a taskKey to follow with get_task_status.
  • import_to_projectImport to projectPOSTImports a Word, RTF, EPUB, ODT, HTML, Markdown, DocFX, OpenAPI (AutoDocs) or project-backup file into an existing project, from a URL or base64 content. Returns a taskKey to follow with get_task_status.

Ask, 1 operation

  • ask_answer_geniusAsk answer geniusPOSTAsks AnswerGenius, the portal's AI assistant, a question answered from the portal's documentation; pass chatId to continue a conversation. Each call spends ClickHelp AI Points (CAPs), test requests included.

Child, 1 operation

  • list_toc_node_childrenList toc node childrenGETLists the child nodes of a table-of-contents node; isRecursive also returns every nested level.

Download, 1 operation

  • create_project_backupCreate project backupPOSTCreates a backup archive of a project and saves it in the portal Storage at outputFileName. Returns a taskKey to follow with get_task_status.

Export, 1 operation

  • export_publicationExport publicationPOSTExports a publication to a file (PDF, DOCX, DOC, RTF, EPUB, ODT, MHT, CHM, Markdown, WebHelp or plain HTML) saved in the portal Storage at outputFileName. Returns a taskKey to follow with get_task_status.

Publication, 1 operation

  • list_project_publicationsList project publicationsGETLists the publications built from one project: id, title, language, visibility and URL.

Publish, 1 operation

  • publish_projectPublish projectPOSTPublishes a project as a new online publication (pubId, pubName) or updates an existing one (updatedPubId, updateMode), which changes what its readers see; a Public publication is open to everyone. Returns a taskKey for get_task_status.

Search, 1 operation

  • search_portalSearch portalGETRuns a full-text search across the portal's projects and publications the API user can access and returns the matching topics (title, project, URL, keywords), the top 10 unless count says otherwise.

Search query, 1 operation

  • get_search_queries_reportGet search queries reportGETReports the search queries a portal user (or anonymous readers, with user-login -) ran between startDate and endDate, with the number of results; projectId narrows it. Personal data.

Task, 1 operation

  • get_task_statusGet task statusGETReturns the progress of a long project job (create, import, backup, publish, export, delete): whether it is still working, succeeded, its status text and progress.

Use ClickHelp from Claude Code, Cursor or Codex

Connect ClickHelp in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its ClickHelp operations become tools the client can call, next to every other integration you connected.

Claude Code
claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"
Codex (~/.codex/config.toml)
[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"
Cursor, Claude Desktop and other JSON configs
{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect ClickHelp

  1. Create your workspace

    Sign up free. Nothing to install.

  2. Connect ClickHelp once

    Add your ClickHelp connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.

  3. Describe the job in chat

    The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.

ClickHelp integration FAQ

What can you do with the ClickHelp integration?

LiveContext exposes 48 operations on ClickHelp, covering article, node, project and status.

Popular integrations

Browse the whole catalog