Skip to main content
Glama

Convert a local image into a GB Studio sprite

convert_image_to_sprite

Converts a local PNG or JPG into a 4-color DMG-quantised GB Studio sprite sheet. Handles fixed frames or multi-directional animations with automatic quality verification.

Instructions

Read a local PNG/JPG and convert it to a 4-colour DMG-quantised GB Studio sprite. For animationType=fixed the image is treated as one frame. For animationType=multi/multi_movement the input MUST already be a sprite sheet (3 frames wide for multi, 6 frames wide for multi_movement) — single-frame inputs cannot be expanded to multiple directions. After quantisation a heuristic quality check runs: degenerate outputs (near-empty, single-shade, low-detail) refuse to write unless force: true. No API key required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesDisplay name; seeds the slug.
forceNoSkip the post-quantisation quality check and write the sprite even if it looks degenerate.
inputPathYesAbsolute path, or relative to the project root, of the source PNG/JPG.
animationTypeYes
Behavior3/5

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

No annotations are provided, so the description carries full burden. It mentions a heuristic quality check and the force parameter to bypass it, and notes 'No API key required.' However, it does not disclose whether the tool modifies project files, what permissions are needed, or what the return value is. Some behavioral details are missing.

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?

The description is concise (about 100 words) and front-loads the main purpose. It covers all necessary details without redundancy. Minor improvement could be structuring with bullets, but it is efficient.

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?

Given the tool's complexity (4 parameters, no output schema), the description covers the main behaviors, constraints, and edge cases (quality check, input requirements). It could be more complete by stating the return value or effect on the project, but it is largely sufficient.

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

Parameters4/5

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

Schema coverage is 75%, and the description adds significant context for animationType (sprite sheet requirements) and the quality check. It explains the behavior of each parameter beyond the schema, e.g., 'force: true' skips the check. Only animationType lacks a description in schema, but the description compensates.

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 tool converts a local PNG/JPG to a 4-colour DMG-quantised GB Studio sprite. It specifies the animation types and sprite sheet constraints, distinguishing it from sibling tools like generate_sprite.

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 description provides clear constraints for when to use this tool (e.g., input must be a sprite sheet for multi/multi_movement). It does not explicitly mention alternatives or when not to use it, but the context is sufficient for typical 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/gbs-toolkit/mcp-server'

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