Skip to main content
Glama

notebook_read

Read a notebook file and list its cells with indices, types, and source previews to inspect structure before editing or running it.

Instructions

Read a notebook and list its cells with indices, types, and source previews.

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": {
      "path": "<path>"
    },
    "name": "notebook_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the burden alone. It helpfully discloses what is returned (cells with indices, types, source previews), which implies a non-mutating operation, but says nothing about failure modes for a bad path, path resolution rules, or size/truncation limits on previews.

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?

A single front-loaded sentence that states the action first and the return shape second, with no filler or redundancy.

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 one-parameter read tool with an output schema present, the description covers purpose and previews the return content, which is close to sufficient. The remaining gap is path semantics and error behavior, both absent from schema and description.

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 0% for the single 'path' parameter, so the description would ideally clarify the expected format (e.g. notebook file path, relative vs absolute, .ipynb). It only implies that the path targets a notebook, adding minimal meaning beyond the schema.

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

Purpose4/5

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

Specific verb plus resource ('Read a notebook') and it further specifies the output shape ('list its cells with indices, types, and source previews'). That distinguishes it from the mutating siblings (notebook_add_cell, notebook_edit_cell, notebook_run_cell). It stops short of an explicit contrast statement, so a 4 rather than a 5.

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

Usage Guidelines3/5

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

Usage is only implied: the verb 'read' signals inspection as opposed to editing or execution, and siblings make the read-vs-write split inferable. There is no explicit when-to-use, no precondition (e.g. must the notebook exist, is a runtime needed), and no named alternative.

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