Godot Docs MCP Server
Provides tools for searching Godot Engine documentation by keyword, class name, or topic, and reading full documentation for specific Godot classes.
This server does not currently have a deployable release on Glama. Follow the repository's setup instructions to install and configure it for your MCP client, including any required credentials and local dependencies.
Godot Docs MCP Server
A lightweight MCP (Model Context Protocol) server that provides full-text search over Godot Engine documentation.
Features
🔍 BM25 full-text search for relevant documentation results
📚 Search by class name, feature, or topic
💡 Read full documentation for any class
🚀 Zero configuration - just install and use
🌐 Works offline after initial indexing
Related MCP server: Godot Docs MCP
Installation
npm install -g godot-docs-mcpOr use directly with npx:
npx godot-docs-mcpUsage
With PI Agent
Start the MCP server:
godot-docs-mcpIn PI, run
/mcpand add the server:
pi mcp add godot-docs -- npx godot-docs-mcpUse the tools:
User: How do I use WebSocketPeer in Godot?
Assistant: *calls godot_search*Available Tools
godot_search(query, limit?)
Search Godot documentation by keyword, class name, or topic.
Parameters:
query(string, required): Search querylimit(number, optional): Max results (default: 10)
Example:
godot_search("WebSocketPeer HTTPRequest")godot_read(class_name)
Read full documentation for a specific class.
Parameters:
class_name(string, required): Class name
Example:
godot_read("WebSocketPeer")godot_index(force?)
Index or update the documentation database.
Parameters:
force(boolean, optional): Force re-indexing
Example:
godot_index()Development
Prerequisites
Node.js 18+
npm
Setup
git clone https://github.com/tu-usuario/godot-docs-mcp.git
cd godot-docs-mcp
npm installBuild
npm run buildRun in Development
npm run devIndex Documentation
npm run indexLicense
MIT License
Copyright (c) 2024 DreamFus Community
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Contributing
Contributions are welcome! Here's how you can help:
Fork the repository
Create your feature branch (
git checkout -b feature/AmazingFeature)Commit your changes (
git commit -m 'Add some AmazingFeature')Push to the branch (
git push origin feature/AmazingFeature)Open a pull request
Development Guidelines
Follow the existing code style
Add tests for new functionality
Update documentation as needed
Keep PRs focused and small
Roadmap
✅ Publish to npm as
godot-docs-mcp✅ Integrate with PI MCP system
Full documentation scraping from docs.godotengine.org
Semantic search with embeddings (optional)
Multi-language support
DreamFus protocol documentation
Community-contributed recipes and examples
Acknowledgments
Godot Engine - The fantastic game engine
Model Context Protocol - The protocol this server implements
Better SQLite3 - Fast SQLite for Node.js
Related
PI Coding Agent - The AI coding agent
Godot Engine - The fantastic game engine
Support
If you find this useful, consider:
⭐ Starring the repository
🐛 Reporting bugs
💡 Suggesting features
🤝 Contributing code
Made with ❤️ for the Godot community
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
This server cannot be deployed
Maintenance
Related MCP Connectors
Search and read Rust documentation for the standard library and any crate on crates.io
Versioned documentation registry and semantic search for AI tools and coding assistants.
Search and read Apple developer documentation, HIG, and WWDC transcripts as Markdown.
Semantic search over Handsontable and HyperFormula docs, API reference, release notes, and issues.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables AI agents to search and retrieve information from the official Godot game engine documentation. Provides tools to search documentation, get page content, and access detailed class information.24MIT
- AlicenseNot gradedqualityCmaintenanceEnables searching and retrieving Godot Engine documentation across multiple versions (stable, latest, 4.3-4.5) using fuzzy search, returning documentation content as markdown.26MIT
- FlicenseNot gradedqualityDmaintenanceQuery Godot Engine documentation with full-text search across classes, methods, properties, and inheritance.1-
- AlicenseNot gradedqualityNot gradedmaintenanceEnables searching and retrieving Godot documentation pages using fuzzy search, with support for multiple documentation versions.MIT