Engine Openapi MCP

🚀 Shendao Engine OpenAPI MCP Toolset

The Shendao Engine OpenAPI MCP Toolset is a set of interface tools for interacting with the Shendao Engine. It aims to help developers manage game logic, data storage, and AI-assisted features more efficiently. This toolset covers script management, data storage management, and AI-enhanced features, and is suitable for both browser and Node.js environments.

🚀 Quick Start

The Shendao Engine OpenAPI MCP Toolset provides a convenient way to interact with the Shendao Engine. You can start using it by following the integration guides below.

✨ Features

Script Management

• Save/Update Scripts: Allows developers to upload or update game logic scripts in the Shendao Engine.
• Rename Scripts: Enables easy renaming of scripts to keep the code tidy and organized.
• Code Review: AI-assisted features can automatically detect potential issues in the code and provide suggestions.
• Code Generation and Optimization: Automatically generates efficient and secure game logic code and optimizes it according to the latest best practices.

Data Storage Management

• Basic Operations (CRUD): Supports create, read, update, and delete operations on data, suitable for scenarios such as player statistics and game item information.
• Pagination Query: Handles large amounts of data through pagination to improve system performance and response speed.
• Data Structure Design and Migration: AI-assisted tools help design efficient data models and generate migration scripts to adapt to new data structure requirements.

AI-Assisted Features

• Code Optimization: Uses AI technology to improve code quality, reduce potential errors, and enhance readability.
• Data Modeling and Analysis: AI tools can recommend suitable data models based on historical data and usage scenarios and perform data analysis to discover potential issues.

📦 Installation

Browser Integration

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

// Initialize the client
const mcpClient = new McpClient({
  serverUrl: "https://your-mcp-server.com",
  headers: {
    "Content-Type": "application/json",
  },
});

// Example of using the tools
async function useTools() {
  const result = await mcpClient.callTool("script.list", {
    mapId: "your-map-id",
    token: "your-token",
    userAgent: "your-user-agent"
  });
  
  // Handle the result
  console.log(result);
}

Node.js Integration

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

// Create a transport channel
const transport = new WebSocketClientTransport({
  url: "ws://localhost:3000",
});

// Initialize the client and connect
const client = new Client(
  { name: "dao3-client", version: "1.0.0" },
  { capabilities: { tools: {} } }
);
await client.connect(transport);

// Example of using the tools
const result = await client.callTool({
  name: "script.list",
  arguments: {
    mapId: "your-map-id",
    token: "your-token",
    userAgent: "your-user-agent"
  },
});

🔧 Technical Details

Authentication Mechanism

All API calls require the following authentication information:

• token: An authorization token for verifying the user's identity.
• userAgent: A user agent string to identify the source of the request.

Steps to Obtain Authentication Information

1. Access the Shendao Engine Developer Platform: Log in to the Shendao Engine Developer Platform to obtain the developer key.
2. Generate an Authentication Token: Use the developer key to generate a valid API call token.
3. Include in Requests: Include the generated token and a custom userAgent string in each API request.

Troubleshooting

Request Timeout Issues

If a request times out, check the following possible causes:

• Unstable Network: Ensure a stable network connection, reduce the data transfer volume, or try a different network.
• High Server Load: Retry the request during off-peak hours or optimize the request content to reduce the data volume.
• Large Data Size: Limit the data volume per request to avoid transferring too much data at once.

Type Error Issues

Ensure that values are passed according to the parameter types specified in the documentation:

• Numeric parameters (e.g., limit, offset) must be of the number type.
• Boolean parameters (e.g., isGroup) must be correctly set to the boolean type.

🤝 Contribution Guide

We welcome you to submit issue reports or Pull Requests to improve this project!

1. Fork the Project Repository: Fork the Shendao Engine OpenAPI MCP Toolset repository on GitHub.
2. Submit Changes: Make code modifications based on the main branch and create a new feature branch for development.
3. Submit a Pull Request: Submit your feature branch as a Pull Request and participate in code reviews and discussions.

With this toolset, developers can manage game logic and data storage more efficiently, and leverage AI-assisted features to improve development efficiency and code quality.