金大哥 - engine-openapi-mcp MCP 详情

article

README

🚀 神岛引擎 OpenAPI MCP 工具集

神岛引擎 OpenAPI MCP 工具集是一套强大的接口工具，用于与神岛引擎进行交互。它能助力开发者更高效地管理游戏逻辑、数据存储以及利用 AI 辅助功能，适用于浏览器端和 Node.js 环境。

🚀 快速开始

神岛引擎 OpenAPI MCP 工具集提供了丰富的功能，涵盖脚本管理、数据存储管理和 AI 辅助功能。以下将详细介绍其集成方法和使用步骤。

✨ 主要特性

脚本管理

保存/更新脚本：支持开发者在神岛引擎中上传或更新游戏逻辑脚本。
重命名脚本：可便捷地对脚本进行重命名，使代码保持整洁有序。
代码审查：借助 AI 辅助功能，自动检测代码中的潜在问题并给出建议。
代码生成与优化：自动生成高效、安全的游戏逻辑代码，并依据最新最佳实践进行优化。

数据存储管理

基本操作 (CRUD)：支持创建、读取、更新和删除数据操作，适用于玩家统计数据、游戏物品信息等场景。
分页查询：通过分页功能处理大量数据，提升系统性能和响应速度。
数据结构设计与迁移：AI 辅助工具可帮助设计高效的数据模型，并生成迁移脚本以适应新的数据结构需求。

AI 辅助功能

代码优化：利用 AI 技术提升代码质量，减少潜在错误，提高代码可读性。
数据建模与分析：AI 工具能根据历史数据和使用场景推荐合适的数据模型，并进行数据分析以发现潜在问题。

📦 安装指南

浏览器端集成

import { McpClient } from "@modelcontextprotocol/sdk/client/index.js";

// 初始化客户端
const mcpClient = new McpClient({
  serverUrl: "https://your-mcp-server.com",
  headers: {
    "Content-Type": "application/json",
  },
});

// 使用工具示例
async function useTools() {
  const result = await mcpClient.callTool("script.list", {
    mapId: "your-map-id",
    token: "your-token",
    userAgent: "your-user-agent"
  });
  
  // 处理结果
  console.log(result);
}

Node.js 端集成

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { WebSocketClientTransport } from "@modelcontextprotocol/sdk/client/websocket.js";

// 创建传输通道
const transport = new WebSocketClientTransport({
  url: "ws://localhost:3000",
});

// 初始化客户端并连接
const client = new Client(
  { name: "dao3-client", version: "1.0.0" },
  { capabilities: { tools: {} } }
);
await client.connect(transport);

// 使用工具示例
const result = await client.callTool({
  name: "script.list",
  arguments: {
    mapId: "your-map-id",
    token: "your-token",
    userAgent: "your-user-agent"
  },
});

🔧 技术细节

认证机制

所有 API 调用均需提供以下认证信息：

token：授权令牌，用于验证用户身份。
userAgent：用户代理字符串，标识请求来源。

获取认证信息步骤

访问神岛引擎开发者平台：登录神岛引擎开发者平台以获取开发者密钥。
生成认证令牌：使用开发者密钥生成有效的 API 调用令牌。
在调用中传递：将生成的 token 和自定义的 userAgent 字符串包含在每次 API 请求中。

故障排除

请求超时问题

若出现请求超时，请检查以下可能原因：

网络不稳定：确保网络连接正常，减少数据传输量或尝试其他网络。
服务器负载过高：非高峰期重试请求，或优化请求内容以减少数据量。
数据过大：限制每次请求的数据量，避免一次性传输过多数据。

类型错误问题

确保严格按照文档指定的参数类型传递值：

数值参数（如 limit、offset）必须为数字类型。
布尔值参数（如 isGroup）必须正确设置为布尔类型。

🤝 贡献指南

欢迎提交问题报告或 Pull Request 来改进本项目！

Fork 项目仓库：在 GitHub 上 fork 神岛引擎 OpenAPI MCP 工具集仓库。
提交更改：基于 main 分支进行代码修改，并创建新的功能分支用于开发。
发起 Pull Request：将您的功能分支提交为 Pull Request，参与代码审查和讨论。

通过这套工具集，开发者可以更高效地管理游戏逻辑和数据存储，同时借助 AI 辅助功能提升开发效率和代码质量。

engine-openapi-mcp