Skip to main content
Glama

Look up the Godot 4.7 API

godot_api

Look up exact Godot 4.7 class, member, enum, annotation, or global function details offline before calling engine APIs. Get inheritance-aware info, close matches, and Godot 3-to-4 name mappings.

Instructions

Exact lookup in the official Godot 4.7 class reference, offline: Class, Class.member, Class.Enum.VALUE, @annotation or a global function. A class gives its parents, properties with defaults, methods, signals and enums; a member gives its exact signature and description, found through inheritance. Use it before calling any engine API you are not sure about; when you do not know the exact name, use godot_api_search first. detail brief gives the signature and the first paragraph; full gives the whole entry. An unknown name returns an error with close matches, and a Godot 3 name with its Godot 4 name. It changes no project files; when learning is on, it counts the lookup in Godotwright's local learning file so later misses get better hints (GODOTWRIGHT_LEARN=0 turns that off).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "query": "<query>"
    },
    "name": "godot_api"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYese.g. CharacterBody2D.move_and_slide, Node.ready, @export_range, lerp, Tween
detailNobrief (capped lists) or full (everything); default full

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.6.0
    • changedInput schema / properties / detail / description
      Previous value: -"brief: short output with capped lists; full: everything (default for this premium profile: full)."New value: +"brief (capped lists) or full (everything); default full"
  2. Changed1 schema field changedv0.1.1
    • changedInput schema / properties / detail / description
      Previous value: -"Output detail (default for this premium profile: full)."New value: +"brief: short output with capped lists; full: everything (default for this premium profile: full)."
  3. First observedv0.1.0

TDQS

A4.4/5.0
Behavior3/5

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

Rich disclosure beyond the annotations: fully offline, changes no project files, error behavior with close matches and Godot 3 to 4 name mapping, and the learning-file side effect with a GODOTWRIGHT_LEARN=0 opt-out. readOnlyHint=false is unusual for a lookup, and the description explains it only implicitly (the local learning write); it never states the tool is read-only against the project in annotation terms, so the reconciliation is inferential rather than explicit.

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 identity and scope, then query forms, then when-to-use, then detail levels and error behavior. Dense with backticked tokens but each clause carries information; the learning-file aside is the one element that could be trimmed or moved.

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?

No output schema exists, and the description compensates by describing what a class lookup returns (parents, properties with defaults, methods, signals, enums) and what a member lookup returns (exact signature and description, resolved through inheritance). Error and edge-case behavior is also covered, leaving nothing an agent needs in order to call it correctly.

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 100%, so baseline is 3, but the description earns more: it defines what brief contains (signature plus first paragraph) versus full (the whole entry), and it spells out the accepted query syntaxes beyond the schema's ad hoc examples. It also documents inheritance-resolved member lookup, which affects what a member query returns.

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?

States a specific verb and resource: exact lookup in the official Godot 4.7 class reference, offline. It enumerates the accepted query forms (Class, Class.member, Class.Enum.VALUE, @annotation, global function) and names the sibling it is not (godot_api_search) for fuzzy cases, so an agent can distinguish it without opening either 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?

Gives an explicit when-to-use rule ('before calling any engine API you are not sure about') and an explicit alternative with the selecting condition ('when you do not know the exact name, use godot_api_search first'). Nothing about routing is left to inference.

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