penpot_list_file_snapshots

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

With no annotations, the description discloses key behaviors: types of snapshots (user vs system), expiration of system backups, and the return fields (id, label, revn, createdAt, createdBy, lock state). This adds value beyond what is in the schema.

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

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

The description is three sentences with clear structure: purpose, return details, and usage tip. It is concise without unnecessary words, though it could be slightly more compact.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple list tool with one parameter and no output schema, the description covers the essential information—return fields, distinction of snapshot types, and how to use the result. It is complete for its complexity.

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

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

The only parameter, fileId, has 0% schema description coverage. The description does not explicitly describe the parameter; it only implies its necessity ('for a Penpot file'). It adds minimal meaning beyond the schema's type and requirement.

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

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

The description clearly states 'List all named snapshots (version history) for a Penpot file.' It specifies the resource (file snapshots) and the action (list), distinguishing it from sibling tools like penpot_create_file_snapshot and penpot_restore_file_snapshot.

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

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

The description explains when to use the tool: to view snapshots for version history or rollback. It differentiates between explicit and system snapshots and directs the user to use the returned id with penpot_restore_file_snapshot. It does not explicitly state when not to use it, but the context is clear.

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