Skip to main content
Glama

Get Knowledge Notebook Overview

get_knowledge_notebook_overview
Read-onlyIdempotent

A notebook's overview: the summary written from its sources, document counts by state, and which sources are ready.

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": {
      "notebook_id": "<notebook_id>"
    },
    "name": "get_knowledge_notebook_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
app_idNoOptional app whose notebooks to use. Omitted: the owner's own Business Brain.
notebook_idYesThe notebook id, from list_knowledge_notebooks.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.9/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety and side-effect profile is fully covered structurally. The description adds useful content scope (summary text, per-state counts, readiness) but says nothing about whether the summary is cached, how stale counts may be, or what happens for a notebook with no sources.

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?

A single short sentence with no padding that puts the core content list up front. It reads as a fragment rather than a statement of action, which slightly weakens the structure but wastes no words.

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

Completeness3/5

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

There is no output schema, so the description carries the burden of describing return values, and it does name the three main payload elements at a high level. It stops short of clarifying the granularity of 'document counts by state' or the shape of 'which sources are ready', leaving the agent with only an approximate sense of the response.

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% and both parameters are documented in-schema, including the app_id fallback to the owner's own Business Brain and the pointer to list_knowledge_notebooks for notebook_id. The description contributes nothing beyond the schema, so the baseline 3 applies.

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

Purpose3/5

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

The description names the resource and enumerates its contents (summary, document counts by state, ready sources), which is reasonably specific. However, it is a noun-phrase fragment with no verb and no mention of siblings such as ask_knowledge_notebook or list_knowledge_notebooks, so the agent must infer that this is a read of a derived overview rather than a query interface.

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

Usage Guidelines2/5

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

No guidance on when to use this instead of ask_knowledge_notebook, list_knowledge_documents, or read_knowledge_document, and no prerequisites or exclusions are stated. The agent must derive usage purely from the returned-content list.

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