Provides intelligent access to React Native Godot documentation, examples, and implementation guides from the react-native-godot GitHub repository, including documentation search, code examples, API references, and direct file access.
Enables access to React Native Godot documentation and examples, including setup instructions, API references, troubleshooting guides, and code examples for integrating Godot with React Native applications.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@React Native Godot Documentation MCP Servershow me how to initialize React Native Godot on iOS"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
React Native Godot Documentation MCP Server
A powerful Model Context Protocol (MCP) server for intelligent access to React Native Godot documentation, examples, and implementation guides. This server enables LLMs to efficiently fetch and search documentation from the react-native-godot repository by Born.com and Migeran.
π Features
Agent-Centric Design
This MCP server follows best practices for agent-oriented tool design:
Workflow-focused tools that enable complete tasks, not just API wrapping
Optimized for context efficiency with configurable detail levels
Actionable error messages that guide agents toward solutions
Natural task subdivisions with intuitive tool naming
Available Tools
π get_documentation
Fetch specific sections of React Native Godot documentation:
Overview, installation, initialization
API usage, threading, views
Export, debugging, custom builds
Configurable detail levels (concise/detailed/full)
π search_documentation
Intelligent search across all documentation:
Keyword-based search with relevance scoring
Returns most relevant sections
Perfect for finding specific topics or troubleshooting
π» get_example_code
Retrieve working code examples for:
Initialization and setup
API usage patterns
Signal handling
View embedding
Worklets and threading
Complete application examples
π οΈ get_setup_instructions
Platform-specific setup guidance:
iOS and Android configurations
Debugging setup options
Custom build instructions
Step-by-step installation process
π get_api_reference
Detailed API documentation for:
RTNGodot class methods
RTNGodotView component
runOnGodotThread function
Signals and callables
Property access patterns
π§ get_troubleshooting
Solutions for common issues:
Build errors
View display problems
Threading issues
Export problems
Performance optimization
π get_file_from_repo
Direct access to repository files:
Example implementations
Configuration files
Build scripts
Native code
π¦ Installation
Prerequisites
# Python 3.8+
python --version
# Install MCP and FastMCP
pip install mcp fastmcpInstall Dependencies
pip install httpx pydanticMake Executable
chmod +x react_native_godot_mcp.pyπ― Usage
Running the Server
Standalone Mode
python react_native_godot_mcp.pyWith MCP Inspector (for testing)
npx @modelcontextprotocol/inspector python react_native_godot_mcp.pyIntegration with Claude Desktop
Add to your Claude configuration file:
MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json
{
"mcpServers": {
"react-native-godot": {
"command": "python",
"args": ["/path/to/react_native_godot_mcp.py"],
"env": {}
}
}
}Integration with Other MCP Clients
The server uses stdio transport and can be integrated with any MCP-compatible client:
# Example Python client usage
from mcp import Client
client = Client()
client.connect_stdio(["python", "react_native_godot_mcp.py"])
# Use tools
result = await client.call_tool(
"get_documentation",
{"section": "initialization", "detail": "detailed"}
)π‘ Example Queries
Get Started with React Native Godot
# Fetch installation instructions
get_setup_instructions(platform="both", include_debugging=True)
# Get initialization example
get_example_code(topic="initialization", platform="ios")Search for Specific Topics
# Search for worklet information
search_documentation(query="worklets threading", max_results=5)
# Find signal handling docs
search_documentation(query="connect signals JavaScript")Troubleshoot Issues
# Get help with build errors
get_troubleshooting(issue="build_error", platform="android")
# Debug view problems
get_troubleshooting(issue="view_not_showing")Deep Dive into API
# Get RTNGodot API reference
get_api_reference(topic="RTNGodot", include_examples=True)
# Learn about signals
get_api_reference(topic="signals")π§ͺ Running Evaluations
The repository includes comprehensive evaluation questions to test the MCP server's capabilities.
Using the Evaluation File
The evaluation file (
react_native_godot_evaluation.xml) contains 10 complex questionsEach question tests the server's ability to find specific information
Questions cover initialization, threading, debugging, API usage, and more
Running Evaluations with MCP
# Install evaluation tools
pip install mcp-eval
# Run evaluation
mcp-eval run react_native_godot_mcp.py react_native_godot_evaluation.xmlManual Testing
You can manually test each tool:
# Test documentation fetching
python -c "
import asyncio
from react_native_godot_mcp import get_documentation
async def test():
result = await get_documentation(None, 'threading', 'markdown', 'detailed')
print(result)
asyncio.run(test())
"ποΈ Architecture
Design Principles
Workflow-Oriented: Tools are designed around common developer workflows
Context-Aware: Adjustable detail levels to optimize token usage
Error-Resilient: Graceful handling with actionable error messages
Format-Flexible: Supports both Markdown and JSON responses
Response Formats
All tools support two response formats:
Markdown: Human-readable, formatted documentation
JSON: Structured data for programmatic use
Detail Levels
Three levels of detail for documentation:
Concise: Key points and headers only
Detailed: Standard documentation with examples
Full: Complete content including all details
π Security & Limits
Character Limit: 25,000 characters per response
Request Timeout: 30 seconds
Max Search Results: 20 per query
Rate Limiting: Respects GitHub API limits
π€ Contributing
This MCP server is designed to be extensible. To add new features:
Add new tool methods with
@mcp.tooldecoratorDefine Pydantic input models for validation
Follow the existing patterns for error handling
Add corresponding evaluation questions
π License
MIT License - Same as React Native Godot
π Credits
MCP Server: Built using the Model Context Protocol by Anthropic
FastMCP: Simplified MCP development framework
π Support
For React Native Godot questions:
Migeran Support (commercial)
For MCP server issues:
Open an issue in this repository
Check the evaluation results for capability verification
π¦ Status
β All documentation sections accessible
β Intelligent search functionality
β Complete example code coverage
β Platform-specific guidance
β Comprehensive troubleshooting
β Direct file access from repository
β 10 evaluation questions for testing
Built with β€οΈ for the React Native and Godot communities
This server cannot be installed
Resources
Looking for Admin?
Admins can modify the Dockerfile, update the server description, and track usage metrics. If you are the server author, to access the admin panel.