Skip to main content
Glama

create_checkpoint

Record installed packages, custom node commits, and PyTorch index to a small text checkpoint, so a later ComfyUI environment change can be undone.

Instructions

Record what is installed, so a later change to the environment can be undone.

Writes a folder of text files - the name==version of every package, what is in custom_nodes and at which commit, and which PyTorch index this install came from. Kilobytes, not gigabytes: models, inputs, outputs and the contents of custom_nodes are not copied. It records what was installed, not the files themselves.

The recorded list is deliberately uv pip list --format=freeze rather than uv pip freeze. The latter reports a wheel install as name @ file:///D:/a/ComfyUI/..., the path on the runner that built the portable archive - measured on 80 of 286 packages here - and a checkpoint written that way cannot be restored on any machine.

Args: note: why this one was taken. Shown in the listing; a checkpoint with no note is hard to tell from the four beside it a month later.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.10

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses what is written (a folder of text files with name==version, custom_nodes contents and commit, PyTorch index), what is deliberately NOT copied (models, inputs, outputs, custom_nodes files), the size profile (kilobytes not gigabytes), and the freeze-format choice with the reason (runner-local file:// paths make a checkpoint unrestorable elsewhere).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose and effect, and the multi-paragraph layout is readable. The `uv pip freeze` rationale, including the 'measured on 80 of 286 packages here' aside, is more detail than an agent needs to invoke the tool, so a little trimming is possible.

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?

An output schema exists, so return values need not be explained, and the description still covers what is recorded, what is excluded, the parameter's purpose, and the intended workflow. Nothing an agent needs in order to call this correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the parameter has no description beyond an empty-string default, so the description must compensate — and it does, explaining that `note` records why the checkpoint was taken, that it appears in the listing, and why omitting it makes checkpoints indistinguishable later.

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?

Names a specific verb+resource (record the installed package state into a checkpoint) and states the goal (so a later environment change can be undone). This clearly separates it from siblings list_checkpoints, restore_checkpoint, and delete_checkpoint, which the agent can distinguish without opening a schema.

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 opening sentence establishes the workflow context: take this before changing the environment so the change can be undone later, which implies the pairing with restore_checkpoint. It does not explicitly name restore_checkpoint or state when-not to use it, so it falls short of the 5-level 'explicit alternatives' bar.

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