Apache Zeppelin MCP Server

get_notebook

Read-onlyIdempotent

Retrieve a notebook overview with paragraph code, titles, and status, excluding outputs; include chart and presentation config when requested.

Instructions

Get notebook overview with all paragraph code, titles, and status. Does not include paragraph output — use get_paragraph to inspect output of specific paragraphs.

For large notebooks, prefer list_paragraphs first to identify paragraphs of interest,
then get_paragraph_code for targeted reads.

Args:
    notebook_id: The notebook ID to retrieve
    include_config: If True, include visualization/chart config and presentation
        flags (editorHide, runOnSelectionChange) for each paragraph. Default False.

Input Schema

Name	Required	Description	Default
`notebook_id`	Yes
`include_config`	No

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.4.1Oct 26, 2026

TDQS

A4.7/5.0

Behavior4/5

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

Read-only, idempotent, and non-destructive traits are already covered by annotations, so the description focuses on payload behavior: outputs are excluded and large-notebook reads should be narrowed first. It stops short of stating anything about response size limits, truncation, or pagination for very large notebooks, which would have earned a 5.

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?

Front-loaded summary sentence, then a scope exclusion, then size-based routing advice, then the args block. Every sentence adds decision-relevant information and nothing is repeated from the schema beyond the parameter names needed for the mapping.

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?

An output schema exists, so return values need no explanation. With two parameters, one of which is fully elaborated, and clear sibling routing, an agent has everything required to select and invoke this tool correctly.

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 description coverage is 0%, so the description must carry the burden, and it largely does: include_config is spelled out as adding visualization/chart config plus presentation flags (editorHide, runOnSelectionChange) with a stated default of False. notebook_id is left as a bare restatement, which is the only gap.

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 and resource ('Get notebook overview') and enumerates exactly what is returned: paragraph code, titles, and status. It also explicitly bounds the payload by excluding paragraph output, which distinguishes it from get_paragraph without requiring the schema to be opened.

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?

Names alternatives and the conditions that select them: get_paragraph for output inspection, list_paragraphs first for large notebooks, then get_paragraph_code for targeted reads. This is explicit when-to-use/when-not-to-use routing against three named siblings.

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