1.6.5 Release

  • New: Generic resource listing tool (ResourceListAsync) for .tres and .res files, supporting directory and resource type filters. This enables automation and scripting scenarios that require resource discovery across a project or subdirectory.

Godot MCP Server

Automated API documentation for the Godot MCP Server solution, generated with DocFX.

Use the navigation bar to browse conceptual articles and the .NET API reference.

Published site: https://ozymandros.github.io/Godot-MCP-Server/ — deployed from the default branch via .github/workflows/docs.yml when documentation-related paths change. If the URL does not resolve, configure GitHub Pages for Ozymandros/Godot-MCP-Server.

Preview locally: do not rely on opening _site/index.html via file://. Use dotnet docfx docs/docfx.json --serve and browse the printed http://localhost URL so the table of contents, navbar, and search load correctly.

Maintainer workflow

  • Regenerate after API or XML-comment changes — Run a Release build, then DocFX, so the API section reflects new types and comments:

    dotnet tool restore
dotnet build GodotMCP.slnx -c Release
dotnet docfx docs/docfx.json

  • Conceptual docs — Add or edit Markdown under this folder (for example articles/) and update toc.yml so pages appear in the table of contents.

  • New assemblies — If you add a project that should appear in the API reference, add it under metadata → src in docfx.json (paths are relative to the docs/ directory).

  • Do not commit generated API YAML — docs/api/ is ignored by Git; it is recreated every time DocFX metadata runs.

  • CI — The docs GitHub Actions workflow builds and publishes the site; keep the same commands working locally before pushing.

  • Preview — Run dotnet docfx docs/docfx.json --serve and use the HTTP URL (avoid opening _site/index.html via file://; see note at the top of this page).

Project paths & auto-initialization

Most MCP tooling accepts an absolute projectPath (in addition to paths relative to the configured server project root). If a requested project directory does not contain a project.godot, the server will automatically create a minimal project.godot and the scenes, scripts, and addons directories so tooling can proceed without requiring manual editor initialization.

For scene and scene-graph tooling specifically, the effective scene path is normalized to projectPath + /scenes/ + fileName. These tools require fileName to end with .tscn and will auto-bootstrap a minimal valid scene when the file is missing, using root_type (default Node).

The new ResourceListAsync tool enables automation and scripting scenarios that require discovery of all Godot resource files in a project or subdirectory, with optional filtering by resource type.

Build locally

From the repository root:

dotnet tool restore
dotnet build GodotMCP.slnx -c Release
dotnet docfx docs/docfx.json

Alternatively, building the documentation project directly (not as part of a full solution build) runs the same DocFX pipeline:

dotnet build Documentation/Documentation.csproj -c Release

Static HTML is written to _site/ at the solution root.

Edit this page