Oo Clickhelp

ClickHelp

Operate ClickHelp through your OOMOL-connected account. This skill calls the clickhelp connector with the oo CLI; OOMOL injects credentials server-side, so you never handle raw tokens.

Running an action

Assume the user has already installed the oo CLI, signed in, and connected ClickHelp. Do not run oo auth login or open the connection URL proactively — just run the action. Fall back to First-time setup only when a command actually fails with an auth or connection error.

1. Inspect the contract to get the authoritative input/output schema before building a payload:

oo connector schema "clickhelp" --action "<action_name>"

2. Run the action with a JSON payload that matches the input schema:

oo connector run "clickhelp" --action "<action_name>" --data '<json>' --json

• --data takes a JSON object string or @path/to/file.json; omit it to send {}.
• The response is { "data": ..., "meta": { "executionId": "..." } }; the execution id lives under meta.executionId.

Each action is listed below with a one-line description; actions that change state carry a [write] or [destructive] tag. Before constructing --data, fetch the action's live schema with oo connector schema to get its authoritative input fields.

Available actions

• create_topic — Create a topic in a ClickHelp project using HTML body content and topic metadata. [write]
• get_project — Get one ClickHelp project or publication by id.
• get_topic — Get one ClickHelp topic, optionally compiling its content as HTML or Markdown.
• list_projects — List ClickHelp projects and publications available to the connected user.
• list_topics — List or search topics within one ClickHelp project or publication.
• search_portal — Search full text across ClickHelp projects and publications available to the user.
• update_topic — Update selected content or metadata fields on a ClickHelp topic. [write]

Safety

• Untagged actions are reads (get / list / search) — safe to run directly.
• Actions tagged [write] change ClickHelp state — confirm the exact payload and effect with the user before running.
• Actions tagged [destructive] remove or overwrite data — always confirm the target and get explicit approval first.

First-time setup

These are one-time steps — do not repeat them on every call. Run a step only when a command fails for the matching reason.

• oo: command not found — install the oo CLI (other platforms: https://cli.oomol.com/install-guide.md):

  curl -fsSL https://cli.oomol.com/install.sh | bash    # macOS / Linux
  

  irm https://cli.oomol.com/install.ps1 | iex           # Windows PowerShell
  

• Not signed in / authentication error — sign in to your OOMOL account once:

  oo auth login
  

• scope_missing / credential_expired / app_not_ready / app_not_found — ClickHelp is not connected, or the connection expired or lacks a scope. Connect once (auth type: API key) at:

  https://console.oomol.com/app-connections?provider=clickhelp
  

• HTTP 402 / OOMOL_INSUFFICIENT_CREDIT — billing stop. Recharge at https://console.oomol.com/billing/token-recharge before retrying.

Resources

• ClickHelp homepage: https://clickhelp.com