Knowledge Base Overview

Tool ID: kb_overview

Summary

Lists published knowledge base pages under an optional parent path — or the top-level pages when no parent is given.

When to use it

  • See what topics exist — Start here when you do not know the right search terms.
  • Drill into a section — Pass a parent path to list its child pages.
  • Prepare to open a page — Note the path values, then use Get.

What you need

Requirement Required?
Metraclick connection Yes
Tool enabled for your account Yes
Extra service credentials No

Parameters

Parameter Required? Description
parent_path No Parent page path (for example billing). Omit or leave empty for top-level pages.

What you get back

A list of child pages. Each row includes path, title, summary, sort_order, and has_children (whether that page has published children).

{
  "tool": "kb_overview",
  "parent_path": null,
  "row_count": 1,
  "rows": [
    {
      "path": "welcome",
      "title": "Welcome to the Knowledge Base",
      "summary": "Intro to the shared Metraclick knowledge base for agents.",
      "sort_order": 0,
      "has_children": false
    }
  ]
}

Example prompts

Show me the top-level pages in the Metraclick knowledge base.

List the knowledge base topics under billing.

What sections are available in the shared knowledge base?

Tips

  • Only published pages appear. Drafts and archived pages are hidden.
  • Use Search when you know keywords; use Overview when you want to browse.
  • Pass a path from this list to Get to read the full Markdown.

Related