Skip to main content
Glama

add_notebook_figure

Put a drawing that is on screen into the lab notebook as a numbered figure: a chart, gel, map or any other picture a tool drew on the stage. It is appended to the entry the user has open (or to the one you name), captioned with the drawing, the tool that drew it and what that tool concludes now, and numbered where it falls, exactly as the Export panel and a chart's own menu do it. Vector drawings stay vector.

Input Schema

NameRequiredDescriptionDefault
tabNothe stage tab or the tool surface id it shows (e.g. `qpcr-curves`). Leave it out for the tab the user is looking at.
_filesNoThe project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name.
captionNoa caption to use instead of the generated one. Leave it out unless the user asked for wording: the generated caption names the drawing, the tool and its reading.
drawingNothe drawing to take, by its name (a chart's title, e.g. "Melt curve"). Leave it out to take the first drawing of the tab.
_subjectNoThe record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several.
entry_idNoappend to this entry instead of the open one; with neither, a new entry is started and named after the drawing.

Output Schema

NameRequiredDescriptionDefault
figureYesits figure number in that entry, as the preview and every export print it
captionYesthe caption written
entry_idYesthe entry the figure went into

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already state this is a non-readOnly, non-destructive, closed-world mutation. The description adds meaningful behavior beyond that: it appends rather than replaces, generates a caption from the drawing/tool/conclusion, numbers the figure, and preserves vector graphics.

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 is three sentences, front-loaded with the core action and then covering captioning, numbering, and vector preservation. It wastes no space and is appropriately sized for the operation.

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?

With an output schema and complete parameter documentation, return values and parameter details need not be in the description. The description covers the key action and notebook side effects, though it does not explain the _files/_subject context parameters.

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 100%, so all six parameters are already documented. The description reinforces defaults for tab, caption, drawing, and entry_id, but adds little beyond what the schema already says.

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 gives a specific verb and resource—"Put a drawing ... into the lab notebook as a numbered figure"—and lists examples (chart, gel, map). It clearly distinguishes this from drawing/export siblings by framing the action as appending to a notebook entry.

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 makes the usage context clear: take an on-screen drawing and append it to the open entry or a named entry. It does not explicitly compare against alternatives such as export_map_svg or draw_gel, so it falls short of full when/when-not guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources