- Home
- MCP servers
- Godot Docs
Godot Docs
- typescript
17
GitHub Stars
typescript
Language
4 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
This MCP server provides access to Godot’s documentation through a remote MCP endpoint or via a local stdio runner. You can fetch docs for multiple Godot versions, search efficiently, and serve the content to your tooling or editors. It helps you integrate up-to-date Godot docs into your development workflow without bouncing between sites.
How to use
You connect to the MCP server from your MCP client by adding a server entry that points to either the hosted HTTP endpoint or the local stdio runner. The hosted option keeps everything centralized and requires no local runtime, while the stdio option lets you run the MCP locally within your environment.
How to install
Prerequisites: ensure you have Node.js and npm installed on your system. You may also want a modern shell for running commands.
Choose one of the two connection methods described below.
Option A — Use the hosted MCP endpoint (HTTP) and configure your client to connect to the remote URL.
Configure the hosted MCP endpoint (HTTP)
{
"mcpServers": {
"godot": {
"type": "http",
"url": "https://godot-docs-mcp.j2d.workers.dev/mcp",
"args": []
}
}
}
Configure the local MCP runner (stdio)
If you prefer running the MCP locally, you can use a stdio server with the following setup.
{
"mcpServers": {
"godot": {
"command": "npx",
"args": [
"mcp-remote",
"https://godot-docs-mcp.j2d.workers.dev/mcp"
]
}
}
}
Local development workflow
To run a local development server and test against the remote MCP data, install dependencies, start the local server, and configure your client to point to the local endpoint.
npm install
npm run dev
Then configure your client to use the local endpoint, for example:
{ "mcpServers": { "godot": { "command": "npx", "args": ["mcp-remote", "http://localhost:8787/mcp"] } } }
## Deploy to Cloudflare (recommended if you want a hosted MCP)
Deploying to Cloudflare provides a hosted endpoint with a configurable rate limit and avoids local setup each time. The process includes creating a Cloudflare account, installing Wrangler, building, and deploying the worker, then updating your MCP client configuration to use the new worker URL.
1. Create a free Cloudflare account
2. Install Wrangler and login
npm install -g wrangler wrangler login
3. Adjust runtime settings in wrangler.jsonc as needed and deploy
git clone https://github.com/your-repo/godot-docs-mcp.git cd godot-docs-mcp npm install npm run deploy
After deployment, update your MCP config to point to the new worker URL:
```json
{
"mcpServers": {
"godot": {
"type": "http",
"url": "https://godot-docs-mcp.YOUR-SUBDOMAIN.workers.dev/mcp",
"args": []
}
}
}
Adjust the rate limit if needed in wrangler.jsonc under ratelimits. See the example below for increasing or disabling rate limiting.
## Additional considerations
The docs site uses a search index to locate pages and expose content via the MCP. You can switch between versions such as stable, latest, 4.6, 4.5, 4.4, and 4.3 depending on your needs.
## Available tools
### search\_docs
Search the Godot docs by term for a given version and return matching documentation URLs.
### get\_docs\_page\_for\_term
Fetch the full documentation page for the first matching result of a search term.