README.md
Provides access to Godot engine documentation through a RAG system
A MCP server for Godot RAG
This MCP server is used to provide Godot documentation to the Godot RAG model.
Screenshot
Before using
After using
MCP server config
{
"mcpServers": {
"godot-rag": {
"command": "python",
"args": [
"",
"-d",
"",
"-c",
"<name of the collection in the chroma_db>"
]
}
}
}
Setup
uv venv --python 3.12
source ./.venv/bin/activate
uv sync
cp .env.example .env.local
Initiation steps
# clone godot docs
python download_godot_docs.py
# convert rst to markdown
python convert_rst2md.py
# chunk markdown files
python chunker.py -i artifacts
# create vector database
python vectorizer.py -i artifacts/chunks/artifacts_chunks_SZ_400_O_20.jsonl
# python vectorizer_api.py -i artifacts/chunks/artifacts_chunks_SZ_400_O_20.jsonl -m BAAI/bge-m3
# start mcp server
python main.py -d artifacts/vector_stores/chroma_db -c artifacts_chunks_SZ_400_O_20_all-MiniLM-L6-v2
# python main_with_api.py -d artifacts/vector_stores/chroma_db -c artifacts_chunks_SZ_400_O_20_BAAI-bge-m3 -k <your openai api key>
Debug
npx @modelcontextprotocol/inspector \
uv \
--directory . \
run \
main.py \
--chromadb-path artifacts/vector_stores/chroma_db \
--collection-name artifacts_chunks_SZ_400_O_20_all-MiniLM-L6-v2
Use Another Model
Other
mcp_godot_rag is indexed and certified by MCP Review
Environment Variables
OPENAI_API_KEYRequired if using the API-based vectorization or model featuresConfiguration
claude_desktop_config.json
{"mcpServers": {"godot-rag": {"command": "python", "args": ["<path to the server script 'main.py'>", "-d", "<path to the chroma_db on your computer>", "-c", "<name of the collection in the chroma_db>"]}}}Try it
→How do I implement a state machine in Godot 4 using GDScript?
→Explain the difference between Area2D and RigidBody2D based on the documentation.
→What are the best practices for optimizing performance in Godot 3D scenes?
→Find the documentation for handling input events in Godot.