Skip to main content
Glama
ihrpr
by ihrpr

read_notebook_with_outputs

Read a Jupyter notebook's current content and cell outputs to review existing code and results before making any modifications.

Instructions

Read the current version of the notebook at notebook_path, including cell outputs. Use this before modifying a notebook to understand its existing content and determine if changes are needed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
notebook_pathYes
Behavior3/5

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

With no annotations, the description carries the full burden. It adds useful scope ('including cell outputs', 'current version') but does not disclose return format, potential side effects, or error behavior. For a read operation this is acceptable but not thorough.

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?

Two concise sentences: the first includes the action and object, the second provides usage context. Every word earns its place, with no redundant or vague phrasing.

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?

For a simple read tool with one parameter and no output schema, the description provides enough context for selection and invocation: what it reads, what's included, and when to use it. It could mention the return structure, but the purpose and usage are clear.

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?

The schema has one simple parameter (notebook_path) with 0% description coverage. The tool description references notebook_path but only by name, adding no semantic detail about path format, requiredness, or examples. This is minimal but not harmful.

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 uses a specific verb ('Read') and identifies the exact resource ('the notebook at notebook_path') with the key differentiator ('including cell outputs'). This clearly distinguishes it from siblings like read_notebook_source_only and read_output_of_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?

It explicitly states when to use the tool ('before modifying a notebook to understand its existing content'), which provides strong contextual guidance. However, it does not name alternatives or explicitly state when not to use it, so it falls short of the top score.

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/ihrpr/mcp-server-jupyter'

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