MCP 服务器

React Native Godot Documentation MCP Server

Enables intelligent access to React Native Godot documentation, examples, API references, and troubleshooting guides through searchable tools optimized for LLM workflows.

README

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 fastmcp

Install Dependencies

pip install httpx pydantic

Make Executable

chmod +x react_native_godot_mcp.py

🎯 Usage

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 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 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

# Install evaluation tools
pip install mcp-eval

# Run evaluation
mcp-eval run react_native_godot_mcp.py react_native_godot_evaluation.xml

Manual 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())
"