Skip to main content
Glama

read_notebook

Read the full source content of a Jupyter notebook, including cell types and execution counts, with optional pagination to control the number of cells returned.

Instructions

Read the source content (without output) of a connected Notebook. It will return the formatted content of the Notebook (including Index, Cell Type, Execution Count and Full Source Content). ONLY used when the user explicitly instructs to read the full content of the Notebook.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum number of cells to return (0 means no limit)
start_indexNoStarting cell index (0-based) for pagination
notebook_nameYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations, the description carries full burden. It discloses that the tool reads source content without output (implying no side effects), and describes the return format. It does not mention prerequisites like the notebook needing to be connected, which is partially addressed by the phrase 'connected Notebook'.

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?

The description consists of two short sentences: one stating the purpose and output, and one giving the usage condition. It is front-loaded and concisely provides essential information with no unnecessary text.

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?

An output schema exists, so return values are covered. However, the description omits the prerequisite that the notebook must be connected via a sibling tool (e.g., connect_notebook). For a tool with pagination parameters, it does not explain how limit and start_index interact, though these are documented in the schema. The description is adequate but not fully comprehensive.

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 description coverage is 67% (limit and start_index have descriptions, notebook_name only has title). The tool description does not add extra meaning to parameters beyond the schema. Given coverage above 50%, baseline score of 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?

The description clearly states 'Read the source content (without output) of a connected Notebook' and specifies the returned content, including Index, Cell Type, Execution Count, and Full Source Content. This verb+resource combination effectively distinguishes it from the sibling 'read_cell' which reads a single cell.

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?

The phrase 'ONLY used when the user explicitly instructs to read the full content of the Notebook' provides a clear condition for use. It does not explicitly mention when not to use it or alternatives, but the conditional statement is sufficient context for an agent to select the tool appropriately.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ChengJiale150/jupyter-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server