Skip to main content
Glama

get_notebook

Retrieve a notebook's structure including paragraph IDs, status, and first line of text. Use to quickly overview notebook organization.

Instructions

Get a notebook's structure: paragraph IDs, status, and first line of text. Use get_paragraph for full content of a specific paragraph.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
notebookIdYesThe notebook ID
Behavior4/5

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

No annotations are present, so the description carries the full burden. It discloses the return structure (paragraph IDs, status, first line) and implies a read-only operation (get). While it could explicitly state non-destructive behavior, the description is adequate for a simple retrieval tool.

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 sentences with no wasted words. Front-loaded with the core purpose and immediately followed by usage guidance.

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?

For a simple tool with one required parameter and no output schema, the description fully covers what the tool returns and how it relates to a sibling tool. No gaps are evident.

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 100% with one parameter 'notebookId' described as 'The notebook ID'. The description adds no extra meaning beyond the schema, so 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 the verb 'Get' and the resource 'notebook's structure', specifying what is included (paragraph IDs, status, first line of text). It also distinguishes from the sibling tool 'get_paragraph' by noting that tool provides full content.

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?

Provides clear guidance to use 'get_paragraph' for full content, implying this tool is for an overview. Lacks explicit when-not-to-use but effectively sets context for alternative tool usage.

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/mihneamanolache/zeppelin-mcp'

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