Skip to main content
Glama

ClickHelp Published Docs MCP Server

Find TOC Nodes

find_toc_nodes
Read-onlyIdempotent

Search TOC nodes by title substring or topicId glob pattern (e.g. 'install-*'), returns plain-text search results info and YAML-formatted TOC nodes, if found. Use this when you know part of a node's name but not its nodeId. For full-text content search, use search_portal instead. TOC node IDs and topic IDs are unique within a project/publication scope. Works for both projects and publications.

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>"
    },
    "name": "find_toc_nodes"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectIdYesProject or publication identifier. Project IDs are unique across the portal.
maxResultsNoLimit results
isShowInTocNoFilter by visibility
titleContainsNoSubstring match on topic title
topicIdPatternNoGlob pattern for topicId (e.g. 'install-*')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description's job is to add context — and it does, by disclosing that results are plain-text info plus YAML-formatted TOC nodes, and that IDs are unique per project/publication scope. It stops short of noting truncation or what an empty result looks like, but the added context is meaningful.

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?

Front-loads what the tool does, then routing guidance, then scoping caveats — a sensible order with no wasted sentences. The closing two sentences ('IDs are unique within a project/publication scope' and 'Works for both projects and publications') overlap somewhat and could be merged.

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

Completeness4/5

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

With no output schema, the description carries the burden of describing returns, and it does name the result shape (plain-text info plus YAML nodes). For a five-parameter search tool that is close to sufficient; only result-size behavior and empty-result semantics are left unstated.

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

Parameters3/5

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

Schema coverage is 100%, so all five parameters are already documented, including the glob example the description repeats. The description adds only marginal meaning — the scoping note about ID uniqueness — and says nothing about maxResults defaults or how isShowInToc filters. Baseline 3 is appropriate.

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

Purpose5/5

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

States a specific verb (search) and resource (TOC nodes) plus the two matching modes (title substring, topicId glob) with a concrete example. It clearly distinguishes itself from search_portal, so an agent can identify it without opening the schema.

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 an explicit selection rule ('use this when you know part of a node's name but not its nodeId') and names the alternative for the other case ('for full-text content search, use search_portal instead'). The trigger condition is concrete rather than implied.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources