mcpField
G
godot-api

godot-api

github.com/htdt开发7.2k66 次安装2 周前更新
代码仓库

关于 godot-api

godot-api 是用于查询 Godot API 的窄范围参考技能，面向需要具体类、方法或 C# 用法信息的调用方。它按问题查阅相关文档，只返回所需内容。

主要功能

  1. 01按类查找 Godot API 文档
  2. 02根据问题定位相关类
  3. 03提供方法、信号和模式说明
  4. 04查询 Godot C# 语法参考
  5. 05限制检索范围以减少无关内容

适用场景

  1. 01查找碰撞检测相关 API
  2. 02查看指定类的 API 摘要
  3. 03查询 Godot 中的 C# 写法
  4. 04针对特定 API 问题快速定位文档

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/godot-api确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

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

详细介绍

Godot API 查询

此技能是一个范围有限的参考工具。请针对提问者的问题给出回答。

不要列出或枚举 ${GODOT_API_SKILL_DIR}/doc_api/ 或 ${GODOT_API_SKILL_DIR}/doc_source/。这些目录包含近千个文件，列出它们会浪费上下文。请通过 _common.md、_other.md 和实际需要的特定类文件进行查找。

如何回答

  1. 如果你已经知道类名或可能的类名，请在 ${GODOT_API_SKILL_DIR}/doc_api/_common.md 和 _other.md 中搜索类名，而不是阅读整个索引文件。
  2. 如果提问者没有指定类名，请使用 ${GODOT_API_SKILL_DIR}/doc_api/_common.md 和 _other.md 确定可能的候选类，然后只阅读相关文档。
  3. 只阅读相关的 ${GODOT_API_SKILL_DIR}/doc_api/{ClassName}.md 文件。
  4. 只返回提问者需要的内容：
    • 具体问题（例如“如何检测碰撞”）-> 返回相关方法、信号或模式，并附上简短说明
    • 完整 API 请求（例如“CharacterBody3D 的完整 API”）-> 返回整个类文档摘要

C# 语法参考： ${GODOT_API_SKILL_DIR}/csharp.md — Godot 的 C# 语法、惯用写法和示例。当提问者询问 Godot 的 C# 语法、惯用写法或常见模式（如输入处理、补间、状态机或信号）时，请阅读此文件。

如果 doc_api 为空，请进行引导初始化：

bash ${GODOT_API_SKILL_DIR}/tools/ensure_doc_api.sh

评论

支持 Markdown