Skip to main content
Glama
playcanvas

PlayCanvas Editor MCP Server

Official
by playcanvas

get_checkpoint

Read-only

Fetch a specific checkpoint's metadata by ID to view its creation time, description, and author. Ideal when you need details for one checkpoint, not a full list.

Instructions

Get a single checkpoint by its id. Returns the checkpoint record ({ id, createdAt, description, user }). When NOT to use: to list a branch's checkpoints (use list_checkpoints).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
checkpointIdYesId of the checkpoint to get (from list_checkpoints)
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds behavioral value by specifying the exact return record shape ({ id, createdAt, description, user }), which is especially useful since no output schema is provided. It does not describe not-found behavior, but this is minor for a simple read 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?

The description is two concise sentences with no filler. The primary purpose is front-loaded, the return shape is usefully specified, and the exclusion/alternative is stated efficiently. Every sentence earns its place.

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 single-parameter, read-only tool with no output schema, the description covers the core call semantics, the return shape, and the main alternative. Nothing essential for correct invocation is missing.

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%, and the parameter description already explains 'Id of the checkpoint to get (from list_checkpoints).' The tool description adds little beyond restating 'by its id,' so the schema carries the semantic weight. Baseline 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 states a specific verb and resource: 'Get a single checkpoint by its id.' It also explicitly differentiates from list_checkpoints by saying not to use it for listing a branch's checkpoints, so an agent can distinguish the tool from its closest sibling without opening the schema.

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

Usage Guidelines5/5

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

The description provides explicit when-to-use context ('Get a single checkpoint by its id') and an explicit when-not-to-use condition with the correct alternative: 'to list a branch's checkpoints (use list_checkpoints).' This is clear routing guidance beyond simple domain inference.

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/playcanvas/editor-mcp-server'

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