๐ React Native Godot Documentation MCP Server
A powerful Model Context Protocol (MCP) server that enables intelligent access to React Native Godot documentation, examples, and implementation guides. This server allows LLMs to efficiently retrieve and search documentation from the react-native-godot repository by Born.com and Migeran.
๐ Quick Start
This MCP server offers a range of tools for accessing React Native Godot documentation. To get started, you need to install the necessary dependencies and make the server executable. After that, you can run the server and integrate it with different clients.
โจ Features
Agent-Centric Design
This MCP server adheres to best practices for agent-oriented tool design:
- Workflow-focused tools: These tools are designed to complete entire tasks, not just wrap APIs.
- Optimized for context efficiency: They feature configurable detail levels.
- Actionable error messages: These messages guide agents towards solutions.
- Natural task subdivisions: Tools have intuitive names for easy understanding.
Available Tools
๐ get_documentation
Retrieve specific sections of React Native Godot documentation, including:
- Overview, installation, and initialization
- API usage, threading, and views
- Export, debugging, and custom builds
- Configurable detail levels (concise/detailed/full)
๐ search_documentation
Perform intelligent searches across all documentation:
- Keyword-based search with relevance scoring
- Returns the most relevant sections
- Ideal for finding specific topics or troubleshooting
๐ป get_example_code
Obtain working code examples for:
- Initialization and setup
- API usage patterns
- Signal handling
- View embedding
- Worklets and threading
- Complete application examples
๐ ๏ธ get_setup_instructions
Get platform-specific setup guidance:
- iOS and Android configurations
- Debugging setup options
- Custom build instructions
- Step-by-step installation process
๐ get_api_reference
Access detailed API documentation for:
- RTNGodot class methods
- RTNGodotView component
- runOnGodotThread function
- Signals and callables
- Property access patterns
๐ง get_troubleshooting
Find solutions for common issues:
- Build errors
- View display problems
- Threading issues
- Export problems
- Performance optimization
๐ get_file_from_repo
Directly access repository files:
- Example implementations
- Configuration files
- Build scripts
- Native code
๐ฆ Installation
Prerequisites
python --version
pip install mcp fastmcp
Install Dependencies
pip install httpx pydantic
Make Executable
chmod +x react_native_godot_mcp.py
๐ป Usage Examples
Running the Server
Standalone Mode
python react_native_godot_mcp.py
With MCP Inspector (for testing)
npx @modelcontextprotocol/inspector python react_native_godot_mcp.py
Integration with Claude Desktop
Add the following 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:
from mcp import Client
client = Client()
client.connect_stdio(["python", "react_native_godot_mcp.py"])
result = await client.call_tool(
"get_documentation",
{"section": "initialization", "detail": "detailed"}
)
Basic Usage
get_setup_instructions(platform="both", include_debugging=True)
get_example_code(topic="initialization", platform="ios")
Advanced Usage
search_documentation(query="worklets threading", max_results=5)
get_api_reference(topic="RTNGodot", include_examples=True)
๐ Documentation
Example Queries
Get Started with React Native Godot
get_setup_instructions(platform="both", include_debugging=True)
get_example_code(topic="initialization", platform="ios")
Search for Specific Topics
search_documentation(query="worklets threading", max_results=5)
search_documentation(query="connect signals JavaScript")
Troubleshoot Issues
get_troubleshooting(issue="build_error", platform="android")
get_troubleshooting(issue="view_not_showing")
Deep Dive into API
get_api_reference(topic="RTNGodot", include_examples=True)
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 questions.
- Each question tests the server's ability to find specific information.
- Questions cover initialization, threading, debugging, API usage, and more.
Running Evaluations with MCP
pip install mcp-eval
mcp-eval run react_native_godot_mcp.py react_native_godot_evaluation.xml
Manual Testing
You can manually test each tool:
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())
"
๐ง Technical Details
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.tool decorator.
- Define 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
- React Native Godot: Created by Born and Migeran.
- MCP Server: Built using the Model Context Protocol by Anthropic.
- FastMCP: Simplified MCP development framework.
๐ Support
For React Native Godot questions:
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