README.md•2.08 kB
# Godot Docs MCP
MCP server for searching Godot documentation
English | [日本語](README_JA.md)
## Overview
Godot Docs MCP is an MCP server specialized for searching the [Godot documentation site](https://docs.godotengine.org/en/stable/). By using this, AI Agents can retrieve necessary information from the latest documentation.

## Requirements
- Node.js 18 or later, or Deno
- MCP clients such as VS Code, Cursor, Claude Desktop, etc.
## Setup
> [!NOTE]
> If you use Deno, replace the command with `deno run jsr:@nuskey8/godot-docs-mcp`.
### Visual Studio Code (VSCode)
Add the following to `.vscode/mcp.json`:
```json
{
"servers": {
"godot-docs": {
"command": "npx",
"args": [
"@nuskey8/godot-docs-mcp@latest",
"-y"
]
}
}
}
```
### Claude Code
Run the following command:
```text
claude mcp add godot-docs -s project -- npx -y @nuskey8/godot-docs-mcp@latest
```
### Cursor
You can install by pressing the button below:
[](https://cursor.com/en/install-mcp?name=godot-docs&config=eyJjb21tYW5kIjoibnB4IEBudXNrZXk4L2dvZG90LWRvY3MtbWNwQGxhdGVzdCAteSJ9)
Or, go to `Cursor Settings > MCP > Add new MCP Server` and add an MCP server that runs the command `npx @nuskey8/godot-docs-mcp`.
### Others
For other tools, please refer to the documentation as needed and add an MCP server that runs the command `npx @nuskey8/godot-docs-mcp`.
## Tools
| Name | Description |
| ---------------------- | ------------------------------------------------------------------------ |
| `godot_docs_search` | Search across all Godot documentation for classes, tutorials, and guides |
| `godot_docs_get_page` | Get the full content of a specific Godot documentation page |
| `godot_docs_get_class` | Get detailed information about a specific Godot class |
## License
This library is provided under the [MIT License](./LICENSE).