文档查询服务器

Godot文档MCP服务器是一个提供可查询访问Godot引擎文档的模型上下文协议服务器,支持全文搜索、类成员查询和继承树查看等功能。

  • by 15195999826
  • Python
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 15195999826/godot-docs-mcp

使用说明

Godot文档MCP服务器

一个模型上下文协议(MCP)服务器,提供对Godot引擎文档的可查询访问。

特性

  • 全文搜索 使用SQLite FTS5跨1066+个Godot类
  • 8个强大的工具 用于查询类、方法、属性、信号和继承
  • 快速查询 带索引数据库(~50-100MB)
  • 零部署依赖性 -单个SQLite文件

安装

cd C:\GodotProjects\godot-docs-mcp
pip install -e .

构建文档数据库

git -C C:\GodotProjects\godot-docs switch stable
git -C C:\GodotProjects\godot-docs pull --ff-only
python scripts/build_index.py C:\GodotProjects\godot-docs --version 4.7

这将解析Godot 4.7稳定的RST文件并创建 src/data/godot_docs.db, 该数据库是由MCP服务器加载的。

使用OpenCode

添加到您的OpenCode配置中:

{
  "mcpServers": {
    "godot-docs": {
      "command": "python",
      "args": ["-m", "src.server"],
      "cwd": "C:\\GodotProjects\\godot-docs-mcp"
    }
  }
}

可用工具

  1. search_class -按名称或描述搜索类
  2. get_class_docs -获取课程的完整文档
  3. get_method_docs -获取特定方法的文档
  4. search_methods -跨所有类的搜索方法
  5. list_class_members -列出一个类的所有成员
  6. get_inheritance_tree -获取继承层次结构
  7. search_by_return_type -按返回类型查找方法
  8. search_guides -搜索教程文档

查询示例

# Search for Node class
search_class(query="Node")

# Get all methods of Control class
list_class_members(class_name="Control", member_type="methods")

# Find methods that return Vector2
search_by_return_type(return_type="Vector2")

# Get inheritance tree for CanvasItem
get_inheritance_tree(class_name="CanvasItem", direction="both")

建筑

  • 数据库:带FTS5全文搜索的SQLite
  • 解析器:用于Godot类文档的基于正则表达式的RST解析器
  • 服务器:使用官方SDK的Python MCP服务器
  • 模式:类、方法、属性、信号、枚举的标准化表

许可证

麻省理工学院