React Native Godot MCP

🚀 React Native Godot文档MCP服务器

这是一个强大的模型上下文协议（MCP）服务器，用于智能访问React Native Godot的文档、示例和实现指南。该服务器使大语言模型（LLMs）能够高效地从 react-native-godot 仓库（由Born.com和Migeran创建）中获取和搜索文档。

🚀 快速开始

本MCP服务器可助力LLMs高效获取和搜索React Native Godot的文档。你可按照以下步骤进行安装和使用：

1. 安装所需依赖，具体安装命令见 “📦 安装指南”。
2. 运行服务器，可选择独立模式或与MCP Inspector结合使用，具体命令见 “🎯 使用方法”。
3. 可根据需求调用不同工具获取文档、示例代码等，具体工具及使用方法见 “✨ 主要特性”。

✨ 主要特性

以代理为中心的设计

此MCP服务器遵循面向代理的工具设计最佳实践：

• 以工作流为中心的工具：能够完成完整任务，而非仅仅是API包装。
• 上下文效率优化：支持可配置的详细级别。
• 可操作的错误消息：引导代理找到解决方案。
• 自然的任务细分：工具命名直观。

可用工具

📖 get_documentation

获取React Native Godot文档的特定部分：

• 概述、安装、初始化
• API使用、线程处理、视图
• 导出、调试、自定义构建
• 可配置详细级别（简洁/详细/完整）

🔍 search_documentation

对所有文档进行智能搜索：

• 基于关键字的搜索，并带有相关性评分
• 返回最相关的部分
• 非常适合查找特定主题或进行故障排除

💻 get_example_code

获取以下方面的可用代码示例：

• 初始化和设置
• API使用模式
• 信号处理
• 视图嵌入
• 工作线程和线程处理
• 完整的应用程序示例

🛠️ get_setup_instructions

提供特定平台的设置指南：

• iOS和Android配置
• 调试设置选项
• 自定义构建说明
• 分步安装过程

📚 get_api_reference

提供以下方面的详细API文档：

• RTNGodot类方法
• RTNGodotView组件
• runOnGodotThread函数
• 信号和可调用对象
• 属性访问模式

🔧 get_troubleshooting

提供常见问题的解决方案：

• 构建错误
• 视图显示问题
• 线程问题
• 导出问题
• 性能优化

📁 get_file_from_repo

直接访问仓库文件：

• 示例实现
• 配置文件
• 构建脚本
• 原生代码

📦 安装指南

前提条件

# Python 3.8+
python --version

# 安装MCP和FastMCP
pip install mcp fastmcp

安装依赖

pip install httpx pydantic

设为可执行文件

chmod +x react_native_godot_mcp.py

💻 使用示例

基础用法

运行服务器

# 独立模式
python react_native_godot_mcp.py

# 与MCP Inspector结合使用（用于测试）
npx @modelcontextprotocol/inspector python react_native_godot_mcp.py

与Claude桌面版集成

将以下内容添加到Claude配置文件中：

• 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": {}
    }
  }
}

与其他MCP客户端集成

# 示例Python客户端用法
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"}
)

高级用法

示例查询

# 开始使用React Native Godot
# 获取安装说明
get_setup_instructions(platform="both", include_debugging=True)

# 获取初始化示例
get_example_code(topic="initialization", platform="ios")

# 搜索特定主题
# 搜索工作线程信息
search_documentation(query="worklets threading", max_results=5)

# 查找信号处理文档
search_documentation(query="connect signals JavaScript")

# 故障排除
# 获取构建错误的帮助
get_troubleshooting(issue="build_error", platform="android")

# 调试视图问题
get_troubleshooting(issue="view_not_showing")

# 深入了解API
# 获取RTNGodot API参考
get_api_reference(topic="RTNGodot", include_examples=True)

# 了解信号
get_api_reference(topic="signals")

📚 详细文档

运行评估

仓库中包含全面的评估问题，用于测试MCP服务器的能力。

使用评估文件

1. 评估文件 (react_native_godot_evaluation.xml) 包含10个复杂问题。
2. 每个问题测试服务器查找特定信息的能力。
3. 问题涵盖初始化、线程处理、调试、API使用等方面。

使用MCP运行评估

# 安装评估工具
pip install mcp-eval

# 运行评估
mcp-eval run react_native_godot_mcp.py react_native_godot_evaluation.xml

手动测试

# 测试文档获取
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())
"

架构设计

设计原则

1. 面向工作流：工具围绕常见的开发者工作流设计。
2. 上下文感知：可调整详细级别以优化令牌使用。
3. 错误恢复能力：通过可操作的错误消息进行优雅处理。
4. 格式灵活：支持Markdown和JSON两种响应格式。

响应格式

所有工具支持两种响应格式：

• Markdown：人类可读的格式化文档。
• JSON：用于编程使用的结构化数据。

详细级别

文档有三个详细级别：

• 简洁：仅包含关键点和标题。
• 详细：包含示例的标准文档。
• 完整：包含所有细节的完整内容。

安全与限制

• 字符限制：每个响应25,000个字符。
• 请求超时：30秒。
• 最大搜索结果：每个查询20条。
• 速率限制：遵守GitHub API限制。

贡献代码

此MCP服务器设计为可扩展的。要添加新功能：

1. 使用 @mcp.tool 装饰器添加新的工具方法。
2. 定义Pydantic输入模型进行验证。
3. 遵循现有的错误处理模式。
4. 添加相应的评估问题。

🔧 技术细节

设计原则

本MCP服务器在设计上遵循了一系列重要原则，以确保其高效性、灵活性和可靠性：

• 面向工作流：工具围绕常见的开发者工作流设计，能够完成完整任务，而非仅仅是API包装，让开发者可以更便捷地使用。
• 上下文感知：支持可调整的详细级别，能够根据实际需求优化令牌使用，避免不必要的信息传输。
• 错误恢复能力：当出现错误时，会提供可操作的错误消息，引导代理找到解决方案，保证系统的稳定性。
• 格式灵活：支持Markdown和JSON两种响应格式，既满足人类阅读需求，也方便编程使用。

响应格式与详细级别

• 响应格式：所有工具支持Markdown和JSON两种响应格式。Markdown格式的响应是人类可读的格式化文档，方便开发者查看；JSON格式的响应则是结构化数据，适用于编程使用。
• 详细级别：文档提供了三个详细级别，分别是简洁、详细和完整。简洁级别仅包含关键点和标题；详细级别是包含示例的标准文档；完整级别则包含所有细节内容，开发者可以根据自己的需求进行选择。

安全与限制

为了保证系统的正常运行和数据安全，本服务器设置了一系列限制：

• 字符限制：每个响应的字符数上限为25,000个，避免过大的响应数据影响性能。
• 请求超时：请求超时时间为30秒，如果在规定时间内没有得到响应，请求将被终止。
• 最大搜索结果：每个查询的最大搜索结果为20条，确保搜索结果的有效性和及时性。
• 速率限制：遵守GitHub API限制，避免对GitHub服务器造成过大压力。

📄 许可证

本项目采用MIT许可证，与React Native Godot相同。

🙏 致谢

• React Native Godot：由 Born 和 Migeran 创建。
• MCP服务器：使用Anthropic的模型上下文协议构建。
• FastMCP：简化的MCP开发框架。

📞 支持

React Native Godot相关问题

• GitHub问题
• Migeran支持（商业支持）

MCP服务器相关问题

• 在本仓库中创建一个问题。
• 检查评估结果以验证功能。

🚦 状态

• ✅ 所有文档部分均可访问
• ✅ 智能搜索功能可用
• ✅ 完整的示例代码覆盖
• ✅ 特定平台的指南
• ✅ 全面的故障排除
• ✅ 可直接从仓库访问文件
• ✅ 10个用于测试的评估问题

为React Native和Godot社区用心打造 ❤️