Skip to main content
Glama

Ask Knowledge Notebook

ask_knowledge_notebook

Ask a notebook a question; the answer comes from its documents, with sources. Waits up to 25 seconds for the answer, otherwise returns the query_job_id for get_knowledge_answer. Without chat_session_id a new conversation starts.

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

Input Schema

NameRequiredDescriptionDefault
app_idNoOptional app whose notebooks to use. Omitted: the owner's own Business Brain.
questionYes
source_idsNoOptional: answer only from these documents.
notebook_idYesThe notebook id, from list_knowledge_notebooks.
chat_session_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior3/5

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

The annotations (readOnlyHint=false, idempotentHint=false) already signal this creates state, and the description usefully confirms it by disclosing the 25-second timeout, the query_job_id fallback, and that omitting chat_session_id starts a new conversation. That is real context beyond the annotations, but it never says the question/answer is persisted into chat history or what happens to the job if abandoned — material omissions for a non-idempotent, state-creating call.

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

Conciseness5/5

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

Three compact clauses, front-loaded with the core action, then the async/timeout behavior, then the session default. No filler and nothing repeated from the name or title.

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 correctly should explain returns, and it does — an answer with sources or a query_job_id. Combined with the schema's parameter docs, an agent has enough to call correctly; only the persistence/lifecycle of the resulting chat thread is 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 60%, and the description adds genuine meaning for chat_session_id (the one high-value parameter left undocumented in the schema) plus the implicit source_ids hint via "with sources." With the majority of the remaining semantics already carried by schema descriptions, this lands at adequate rather than rich.

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+resource ("Ask a notebook a question") and immediately defines the output ("the answer comes from its documents, with sources"), which separates it from read-only siblings like read_knowledge_document or get_knowledge_chat. An agent can tell what this does 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 Guidelines4/5

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

Gives the key operating condition — up to 25 seconds wait, otherwise a query_job_id to hand to get_knowledge_answer — which effectively names the follow-up tool and when to switch to it. It also clarifies the chat_session_id branch (new conversation vs. continuing one). It stops short of contrasting with get_knowledge_chat or explaining when to prefer a stateless question over an existing chat.

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