Engine Openapi MCP

🚀 神島引擎 OpenAPI MCP 工具集

神島引擎 OpenAPI MCP 工具集是一套強大的接口工具，用於與神島引擎進行交互。它能助力開發者高效管理遊戲邏輯、數據存儲以及利用 AI 輔助功能，適用於瀏覽器端和 Node.js 環境，讓開發工作更加輕鬆便捷。

✨ 主要特性

腳本管理

• 保存/更新腳本：開發者可在神島引擎中上傳或更新遊戲邏輯腳本，靈活掌控腳本內容。
• 重命名腳本：能方便地對腳本進行重命名，使代碼結構更清晰、有序。
• 代碼審查：藉助 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：用戶代理字符串，標識請求來源。

獲取認證信息步驟

1. 訪問神島引擎開發者平臺：登錄神島引擎開發者平臺以獲取開發者密鑰。
2. 生成認證令牌：使用開發者密鑰生成有效的 API 調用令牌。
3. 在調用中傳遞：將生成的 token 和自定義的 userAgent 字符串包含在每次 API 請求中。

故障排除

請求超時問題

若出現請求超時，請檢查以下可能原因：

• 網絡不穩定：確保網絡連接正常，減少數據傳輸量或嘗試其他網絡。
• 服務器負載過高：非高峰期重試請求，或優化請求內容以減少數據量。
• 數據過大：限制每次請求的數據量，避免一次性傳輸過多數據。

類型錯誤問題

確保嚴格按照文檔指定的參數類型傳遞值：

• 數值參數（如 limit、offset）必須為數字類型。
• 布爾值參數（如 isGroup）必須正確設置為布爾類型。

貢獻指南

歡迎提交問題報告或 Pull Request 來改進本項目！

1. Fork 項目倉庫：在 GitHub 上 fork 神島引擎 OpenAPI MCP 工具集倉庫。
2. 提交更改：基於 main 分支進行代碼修改，並創建新的功能分支用於開發。
3. 發起 Pull Request：將您的功能分支提交為 Pull Request，參與代碼審查和討論。

通過這套工具集，開發者可以更高效地管理遊戲邏輯和數據存儲，同時藉助 AI 輔助功能提升開發效率和代碼質量。