React Native Godot 文档 MCP 服务器

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

🚀 特性

以代理为中心的设计

此 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 Desktop 集成

添加到您的 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 客户端集成

该服务器使用标准 I/O 传输，并可以与任何兼容 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. 添加相应的评估问题

📄 许可证

MIT 许可证 - 同 React Native Godot

🙏 致谢

• React Native Godot：由 Born 和 Migeran 创建
• MCP 服务器：使用 Anthropic 的 Model Context Protocol 构建
• FastMCP：简化 MCP 开发框架

📞 支持

对于 React Native Godot 的问题：

• GitHub Issues
• Migeran 支持（商业）

对于 MCP 服务器的问题：

• 在此存储库中打开一个问题
• 检查评估结果以验证能力

🚦 状态

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

---

为 React Native 和 Godot 社区打造，充满爱心