Connect ClickHelp to Your AI Agent

Work from the existing documentation before preparing a clear topic revision.

7 tools API key

Try a ClickHelp Task

Copy a prompt into your agent with the oo Skill installed. Add your page links and source notes before running it.

oo Skill ClickHelp

Answer a question from portal topics

Find relevant help content and cite the topics used.

/oo ClickHelp: Search ClickHelp for [question] within projects [IDs, or all] and language [language]. Read the matching topics in Markdown and answer using their content. Include topic titles and links, distinguish project or publication sources, and list unanswered points.

Revise one help topic

Apply final title or body changes to an exact documentation topic.

/oo ClickHelp: Read ClickHelp topic [topic ID] in project [project ID]. Draft revisions for [instructions], then apply final title [title] and final HTML body [body]. Preserve other fields and report the updated topic link and recorded workflow status.

Start Working with ClickHelp

  1. Install OOMOL

    Set up oo CLI and the oo Skill in your agent.

    Install OOMOL →
  2. Connect ClickHelp

    Connect with a ClickHelp Contributor login, API key and HTTPS portal address.

    Connect ClickHelp →
  3. Give Your Agent a Task

    Use /oo with the pages to read, the changes to make, and where to save the result.

    Connection Guide →

Choose Your Agent

  • The contributor must have access to the target project or publication and permission for any intended edits.
  • Editing a topic does not itself publish a new documentation release.

ClickHelp Tools

Search your ClickHelp portal and read topics from projects or publications. AI can answer a documentation question with topic links or revise a specific topic’s title and body from supplied instructions.

Documentation reading

Find projects and publications, search content and read topics.

Topic editing

Create topics or update selected title, body and workflow fields.

7 tools

List Projects

List ClickHelp projects and publications available to the connected user.

clickhelp.list_projects

Get Project

Get one ClickHelp project or publication by id.

clickhelp.get_project

List Topics

List or search topics within one ClickHelp project or publication.

clickhelp.list_topics

Get Topic

Get one ClickHelp topic, optionally compiling its content as HTML or Markdown.

clickhelp.get_topic

Create Topic

Create a topic in a ClickHelp project using HTML body content and topic metadata.

clickhelp.create_topic

Update Topic

Update selected content or metadata fields on a ClickHelp topic.

clickhelp.update_topic

Search Portal

Search full text across ClickHelp projects and publications available to the user.

clickhelp.search_portal

Frequently Asked Questions

Can I read a topic as Markdown?

Yes, request compiled topic content in Markdown or HTML. Markdown is useful for summaries; an updated topic body is supplied as HTML.

How do I search only selected documentation?

Provide the project or publication IDs and language. Keep source IDs and links in the answer so readers know which content it uses.

Does a topic edit publish the documentation?

The connection creates or updates topic records. Publication or release operations are not included.

Connect ClickHelp

About ClickHelp ↗