mcpField
G
godot-api

godot-api

github.com/htdtDevelopment7.2k66 installsUpdated 2w ago
Repository

About godot-api

godot-api is a focused reference skill for looking up Godot APIs, aimed at callers needing information about specific classes or C# usage. It consults relevant documentation and returns only what the question requires.

Key features

  1. 01Looks up Godot API documentation by class
  2. 02Identifies relevant classes from a question
  3. 03Explains methods, signals, and patterns
  4. 04References Godot C# syntax
  5. 05Limits searches to relevant documentation

Use cases

  1. 01Find APIs related to collision detection
  2. 02Review an API summary for a specific class
  3. 03Look up C# syntax in Godot
  4. 04Locate documentation for a specific API question

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/htdt/godogen --skill godot-api

After installing, type/godot-apiin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

csharp.md
gdscript.md
tools/
class_list.py
ensure_doc_api.sh
godot_api_converter.py

Details

From the project README

Godot API Lookup

This skill is a narrow reference tool. Keep answers targeted to the caller's question.

Do not list or enumerate ${GODOT_API_SKILL_DIR}/doc_api/ or ${GODOT_API_SKILL_DIR}/doc_source/. Those directories contain nearly a thousand files and listing them wastes context. Navigate through _common.md, _other.md, and the specific class file you actually need.

How to answer

  1. If you already know the class or likely class, search ${GODOT_API_SKILL_DIR}/doc_api/_common.md and _other.md for the class name instead of reading the whole index files.
  2. If the caller does not name a class, use ${GODOT_API_SKILL_DIR}/doc_api/_common.md and _other.md to identify likely candidates, then read only the relevant docs.
  3. Read only the relevant ${GODOT_API_SKILL_DIR}/doc_api/{ClassName}.md file or files.
  4. Return only what the caller needs:
    • Specific question (for example, "how to detect collisions") -> return the relevant methods, signals, or patterns with short descriptions
    • Full API request (for example, "full API for CharacterBody3D") -> return the whole class doc summary

C# syntax reference: ${GODOT_API_SKILL_DIR}/csharp.md — C# Godot syntax, patterns, and recipes. Read it when the caller asks about C# Godot syntax, idioms, or common patterns such as input handling, tweens, state machines, or signals.

Bootstrap if doc_api is empty:

bash ${GODOT_API_SKILL_DIR}/tools/ensure_doc_api.sh

Comments

Markdown supported