Skip to main content
Glama

Godot docs

docs
Read-only

Search the official Godot class reference for your installed engine version. Check 3→4 migration notes and access built-in game-dev guides.

Instructions

Official Godot class reference for the EXACT engine version installed (signatures from the engine, descriptions from the matching release), plus Godot 3→4 migration notes and built-in game-dev guides. Check here before using an API you are not 100% sure exists in Godot 4 — most broken AI-written GDScript comes from Godot 3 habits.

Actions:

  • search: {query} find classes/methods/properties/signals, e.g. 'move and slide', 'tween property', 'raycast'.

  • class: {name, filter?, full?} class reference: description, properties, methods, signals, enums. filter narrows to members containing text.

  • member: {name: 'Class.member'} full docs for one member.

  • migrate: {query?} Godot 3 → 4 renames and syntax changes (filtered by query), e.g. 'yield', 'KinematicBody2D', 'export', 'tween'.

  • guide: {topic?} built-in guides (no topic = list): editor_first (read before building scenes), gdscript, best_practices, 2d_platformer, top_down, 3d_basics, ui, animation, physics, tilemaps, shaders, audio, save_load, performance, game_feel, and more.

  • status: {} docs index status (version, description download progress).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fullNoFull descriptions instead of summaries.
nameNoClass name, or 'Class.member'.
limitNoMax results.
queryNoSearch text.
topicNoGuide topic.
actionYesWhat to do. See the tool description for each action's parameters.
filterNoOnly members containing this text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=false, and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral context: signatures come from the installed engine, descriptions match the release, the migration action returns 3→4 renames, and status reveals index/download progress. It omits only minor operational details like caching or rate limits.

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 front-loaded with purpose and a high-value warning, then uses a tight action list with inline parameter hints and examples. Every sentence earns its place; the length is justified by the tool's six actions and seven-parameter schema.

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 multi-action, read-only documentation tool with no output schema, the description is essentially complete. It explains each action's inputs, what each returns at a high level, and how the tool fits into a Godot workflow. No critical agent decision is left unspecified.

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 description coverage is already 100%, but the description adds substantial meaning by mapping parameters to actions: query for search, name/filter/full for class, Class.member for member, optional query for migrate, optional topic for guide, and no params for status. It also supplies concrete examples like 'move and slide' and 'KinematicBody2D', which the schema alone does not provide.

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: official Godot class reference, migration notes, and built-in guides for the exact installed engine version. It enumerates all actions and distinguishes itself from sibling API/runtime tools by being a documentation lookup surface. An agent can immediately tell what it does and why it matters.

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 gives clear usage context: 'Check here before using an API you are not 100% sure exists in Godot 4' and provides action-level examples. However, it does not explicitly name sibling tools as alternatives or state when not to use it, so it stops short of the full when/when-not/alternatives criterion.

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