ClickHelp Published Docs MCP Server

Get Topic

get_topic

Read-onlyIdempotent

Get a single topic from the portal with full content. Returns topic metadata, body source and compiled content. The 'body' field contains source HTML (editable, may contain custom tags like ch:var/ that should be typically preserved unless surrounding/related content is removed), while 'md'/'html' is the compiled readable output. Use format='md' for readable content, format='html' for raw HTML output. MUST use isReturnBody=true and use body as topic content if the retrieved data is supposed to be written back to the portal to prevent HTML formatting loss. NEVER use compiled content from the md/html fields as topic content for editing to prevent data loss. Note: Auto-topics (isAutoTopic=true) are read-only and cannot be updated, deleted or used as new parents for TOC update operations. Translation project topics can only have workflow fields (status, assignee, owner) updated. Publication topics are read-only (publications are auto-generated project copies).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectId": "<projectId>",
      "topicId": "<topicId>"
    },
    "name": "get_topic"
  }
}

Input Schema

Name	Required	Description	Default
`format`	No	Output format: 'html' or 'md'. Default is 'md' which returns readable markdown.	md
`topicId`	Yes	Topic ID/slug (e.g., 'getting-started')
`projectId`	Yes	Project or publication ID (e.g., 'my-documentation')
`isReturnBody`	No	Returns the topic body markup when (used for topic editing or checking the exact source), the default is false.

Schema Changelog

Changes observed during successful MCP inspections.

First observedNov 11, 2026

TDQS

A4.5/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond readOnlyHint/idempotentHint, it discloses the data-loss hazard of using compiled md/html for write-back and explains that 'body' holds source HTML with custom tags like <ch:var/> that must be preserved. It further flags read-only topic classes: auto-topics, translation project topics (workflow fields only), and publication copies.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well front-loaded: what it returns, then format choice, then the critical write-back warning, then topic-class restrictions. The caps-locked MUST/NEVER rules are functional emphasis, though the custom-tag parenthetical is dense and the return-value list is slightly restated.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers the full picture an agent needs for a read tool: returned fields (with no output schema present), content-format tradeoffs, safe reuse of body content, and restrictions on auto-topics, translation and publication topics. Nothing material is left for the agent to guess.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, yet the description adds real meaning the schema lacks: the body-vs-md/html distinction and the intended purpose of isReturnBody (editing or verifying exact source). It does not add examples for topicId/projectId, so it is meaningful but not exhaustive.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Get a single topic from the portal with full content') and enumerates what comes back (metadata, body source, compiled content). The word 'single' implicitly separates it from list_topics and search_portal, though no sibling is named explicitly, so it stops short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete selection rules among the format options ('Use format=md for readable content, format=html for raw HTML output') and hard conditions for isReturnBody=true. It also states when the tool's output must NOT be reused (never use compiled content for editing) and which topic classes cannot be modified.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All ClickHelp Published Docs MCP Server tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?