Skip to main content

Godot MCP Documentation Server

Docker Godot MCP License

A Model Context Protocol (MCP) server that provides AI assistants with access to the complete Godot Engine documentation, helping developers with Godot development by serving documentation directly to LLMs.

Purpose

This server bridges the gap between AI assistants and Godot documentation, allowing developers to get instant, accurate answers about Godot classes, tutorials, and features without leaving their AI chat interface.

Deployment

  1. Clone the repository:

    git clone https://github.com/Nihilantropy/godot-mcp-docs.git
    cd godot-mcp-docs
    
  2. Build the Docker image:

    docker build -f deploy/Dockerfile -t godot-mcp-docs:local .
    
  3. Configure your MCP client (Claude Desktop example):

    {
      "mcpServers": {
        "godot-mcp-docs": {
          "command": "docker",
          "args": [
            "run",
            "--rm",
            "-i",
            "godot-mcp-docs:local"
          ]
        }
      }
    }
    

Documentation Structure

The server provides access to the complete official Godot documentation with this structure:

docs/
├── _styleguides
├── _tools
│   └── redirects
├── about
├── classes
├── community
│   └── asset_library
├── contributing
│   ├── development
│   │   ├── compiling
│   │   ├── configuring_an_ide
│   │   ├── core_and_modules
│   │   ├── debugging
│   │   │   └── vulkan
│   │   ├── editor
│   │   └── file_formats
│   ├── documentation
│   └── workflow
├── getting_started
│   ├── first_2d_game
│   ├── first_3d_game
│   ├── introduction
│   └── step_by_step
├── img
└── tutorials
    ├── 2d
    ├── 3d
    │   ├── global_illumination
    │   ├── particles
    │   └── procedural_geometry
    ├── animation
    ├── assets_pipeline
    │   ├── escn_exporter
    │   └── importing_3d_scenes
    ├── audio
    ├── best_practices
    ├── editor
    ├── export
    ├── i18n
    ├── inputs
    ├── io
    ├── math
    ├── migrating
    ├── navigation
    ├── networking
    ├── performance
    │   └── vertex_animation
    ├── physics
    │   └── interpolation
    ├── platform
    │   ├── android
    │   ├── ios
    │   └── web
    ├── plugins
    │   └── editor
    ├── rendering
    ├── scripting
    │   ├── c_sharp
    │   │   └── diagnostics
    │   ├── cpp
    │   ├── debug
    │   ├── gdextension
    │   └── gdscript
    ├── shaders
    │   ├── shader_reference
    │   └── your_first_shader
    ├── ui
    └── xr

Available Tools

  • get_documentation_tree() - Get a tree-style overview of the entire documentation structure
  • get_documentation_file(file_path: str) - Retrieve the content of specific documentation files

Sample Usage

Explore documentation structure:

What documentation is available for Godot?

Get specific class documentation:

Show me the documentation for CharacterBody2D

Learn about tutorials:

What tutorials are available for 2D game development?

Get specific tutorial content:

Show me the first 2D game tutorial

Compare classes:

What's the difference between Node2D and CharacterBody2D?

Recommended System Prompt

For optimal results when working with Godot, use this system prompt:

"When working with Godot game development questions, always search for the latest available documentation using the godot-mcp-docs tools. Start with get_documentation_tree() to understand the documentation structure, then use get_documentation_file() to retrieve specific information about classes, tutorials, or features. Prioritize official Godot documentation over general knowledge when providing Godot-related assistance."

Screenshots

MCP Integration in Claude Desktop

Claude Desktop Integration

Documentation Access Example

Documentation Query Example

Updating Documentation

To update to a newer version of Godot documentation:

Option 1: Rebuild the image

docker build -f deploy/Dockerfile -t godot-mcp-docs:local . --no-cache

Option 2: Update manually inside container

docker run -it --entrypoint /bin/bash godot-mcp-docs:local
# Inside container:
python docs_converter/godot_docs_converter.py
tree docs/. > docs/docs_tree.txt

License

This project is licensed under the MIT License - see the LICENSE file for details.

The Godot documentation content follows the original Godot documentation licensing:

  • Documentation content (excluding classes/ folder): CC BY 3.0
  • Class reference files (classes/ folder): MIT License
  • Attribution: "Juan Linietsky, Ariel Manzur and the Godot community"

Metadata

Release files for iflow-mcp_nihilantropy-godot-mcp-server 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for iflow-mcp_nihilantropy-godot-mcp-server 0.1.1
File Size Uploaded
iflow_mcp_nihilantropy_godot_mcp_server-0.1.1.tar.gz 5.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for iflow-mcp_nihilantropy-godot-mcp-server 0.1.1
File Interpreter ABI Platform
iflow_mcp_nihilantropy_godot_mcp_server-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 14.5 kB

Release files / iflow_mcp_nihilantropy_godot_mcp_server-0.1.1.tar.gz

Download URL iflow_mcp_nihilantropy_godot_mcp_server-0.1.1.tar.gz
Size 5.6 kB
Tags Source
SHA-256 checksum
How to use checksums
611386fbd9aabfa4ad640fad3f4b17950aa19df141b035c0d8fb7309d60033a0
BLAKE2b-256 checksum
How to use checksums
6d81f125a8e720158cfb56145b87cf7a1ec54ad149fe13b88ae68d0171353144
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / iflow_mcp_nihilantropy_godot_mcp_server-0.1.1-py3-none-any.whl

Download URL iflow_mcp_nihilantropy_godot_mcp_server-0.1.1-py3-none-any.whl
Size 8.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
afef53bb93723de88109ad26e18bd286dca0d95ed0055d34ebb033b2d03d1b98
BLAKE2b-256 checksum
How to use checksums
ceaa3e9e75a5a00bbba91ae5ecba34a75b69944fb2fd283c7a6d9a70ebb21ebc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page