Skip to main content
Glama
mcintalmo
by mcintalmo

godot-docs-mcp

CI Build index

一个为 AI 编码代理提供 Godot Engine 文档服务的 MCP 服务器。

与 Unity 和 Unreal 相比,Godot 在 LLM 训练数据中的代表性不足,因此代理经常出现幻觉,编造 GDScript API、发明节点名称,并将 Godot 3.x 的用法套用到 4.x 项目上。该服务器让它们基于真实文档:对手册和教程进行全文搜索,以及基于引擎自身 API 元数据构建的结构化类引用。

基于 MCP 规范修订版 2026-07-28 构建,使用官方的 mcp Python SDK v2,同一服务器也支持所有早期协议修订版。

状态:开发中。 服务器、其工具和资源、命令行以及发布索引的每周工作流均可正常工作,并且已发布 Godot 4.7 的预构建索引,因此 sync 无需构建即可安装。尚未发布到 PyPI——请按如下方式从 git 安装。作为 Claude Code 插件(带技能)打包是后续阶段。

工作原理

文档被离线索引到单个 SQLite 数据库中,因此查找速度快且无需网络连接。

内容

来源

原因

手册、教程、入门指南

godotengine/godot-docs .rst

作者编写的散文

类引用

godotengine/godot doc/classes/*.xml

结构化且类型化——.rst 类页面由此生成,因此 XML 提供精确签名而非散文

docs.godotengine.org 位于 Cloudflare 质询之后,该质询拒绝非浏览器客户端,因此不使用渲染后的站点作为来源。所有内容均来自 GitHub。

Related MCP server: Godot MCP Documentation Server

入门

安装预构建索引。只需下载约 8 MB,每个 Godot 版本只需执行一次。

uvx --from git+https://github.com/mcintalmo/godot-docs-mcp godot-docs-mcp sync
uvx --from git+https://github.com/mcintalmo/godot-docs-mcp godot-docs-mcp status

然后让客户端指向它。对于 Claude Code:

claude mcp add godot-docs -- \
  uvx --from git+https://github.com/mcintalmo/godot-docs-mcp godot-docs-mcp

没有针对您想要的版本发布索引,或者正在处理解析器?请从源代码构建。这需要 git,大约需要一分钟:

uvx --from git+https://github.com/mcintalmo/godot-docs-mcp godot-docs-mcp sync --rebuild

问一个模型通常会答错的问题——“move_and_slide 的正确 4.x 签名是什么?”——答案应该从 get_godot_class_member 返回为 bool move_and_slide(),没有参数。在 Godot 3.x 中需要几个参数,而大多数训练数据记住的正是这一点。

命令

命令

用途

godot-docs-mcp

通过 stdio 提供服务。这是客户端启动的命令;serve 是默认值

godot-docs-mcp sync

下载预构建索引。--rebuild 改为从源代码构建

godot-docs-mcp status

索引了什么、基于什么构建的,以及是否已过时。--json 用于脚本

godot-docs-mcp search "how do I make a character jump"

使用工具相同的代码运行查询,并打印排名

godot-docs-mcp package

为已安装的索引写入发布资产。用于构建工作流

每个设置也是一个环境变量,前缀为 GODOT_DOCS_MCP_——请参阅 config.py 获取完整表格。

保持最新

文档会随时更改,因此有两件事会独立跟踪它。

一个每周工作流检查上游提交是否已移动,如果已移动,则重新构建索引,查询整个语料库以确认其能回答,并将其发布为发布资产。godot-docs-mcp sync 就是它到达您的方式。

正在运行的服务器每天在后台检查一次是否有更新的索引已发布。它永远不会下载一个——过时的索引仍然能针对其构建的版本正确回答,是否替换由您决定。它所做的只是说明:在 godot://status 中,以及在搜索结果上以一行 notice 的形式说明。如果检查无法运行,则答案为“无法检查”,绝不会是“最新”。

工具

每个工具都是只读的,每个响应都有限制,因此一次调用不会挤占它本应告知的对话。被截断的响应会说明,并指出返回其余部分的调用。

工具

用途

search_godot_docs

对手册、教程和类引用进行排名搜索。支持用简单语言提问

fetch_godot_doc

获取一个页面或其中的单个部分

get_godot_class

类的继承链和签名映射——没有散文,因此 300 KB 的类条目也能回答

get_godot_class_member

单个成员的精确签名和完整描述

search_godot_code_examples

GDScript 和 C# 代码片段,以及它们来自的页面和标题

资源

URI

内容

godot://status

索引版本、计数以及构建它的上游提交

godot://index

语料库的地图:包含什么、如何寻址、调用哪个工具

godot://doc/{path}godot://doc/{path}#{anchor}

一个页面或其中的一个部分

godot://class/{name}godot://class/{name}#{member}

一个类或其中的一个成员

515 个页面和 1,078 个类不会resources/list 中枚举。模板是每个工具已经返回的 URI,因此搜索命中后,主机无需额外工具调用即可跟进。

开发

需要 uv

uv sync --dev
uv run pre-commit install

命令

用途

uv run pytest

单元测试套件(无网络,隔离运行)

uv run pytest -m slow

针对真实索引的集成测试

uv run ruff check --fix && uv run ruff format

代码检查和格式化

uv run ty check

类型检查

uv run pre-commit run --all-files

运行 CI lint 作业的所有内容

有关架构和贡献约定,请参阅 CLAUDE.md

许可证

MIT。Godot 文档本身由 Juan Linietsky、Ariel Manzur 和 Godot 社区根据 CC BY 4.0 许可;本项目重新分发其索引形式,且不更改该许可证。

Install Server
A
license - permissive license
A
quality
A
maintenance

Maintenance

Maintainers
Response time
Release cycle
1Releases (12mo)
Commit activity

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Servers

  • A
    license
    Not graded
    quality
    C
    maintenance
    Enables AI agents to search and retrieve information from the official Godot game engine documentation. Provides tools to search documentation, get page content, and access detailed class information.
    24
    MIT
  • A
    license
    A
    quality
    D
    maintenance
    Provides AI assistants with direct access to the complete Godot Engine documentation, including classes, tutorials, and features. It enables developers to retrieve and analyze official documentation through natural language interfaces using the Model Context Protocol.
    2
    MIT
  • A
    license
    Not graded
    quality
    D
    maintenance
    Provides AI assistants with access to the complete Godot Engine documentation, enabling developers to get answers about Godot classes, tutorials, and features directly in their chat interface.
    69
    MIT

View all related MCP servers

Related MCP Connectors

  • Provide your AI coding tools with token-efficient access to up-to-date technical documentation for…

  • Search @imqueue docs and scaffold typed services & clients from your AI coding agent.

  • An MCP server that gives your AI access to the source code and docs of all public github repos

View all MCP Connectors

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/mcintalmo/godot-docs-mcp'

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