MCP Server Unified Deployment

🚀 MCP Server

The MCP (MineCraft Pocket Edition) Server is a game server specifically designed for the mobile version of Minecraft. This document provides detailed instructions on how to configure, run, and manage the server.

🚀 Quick Start

Install Dependencies

System Requirements

• Operating System: Linux (Recommended) or Windows
• Memory: It is recommended to have 2GB or more.
• Disk Space: At least 10GB of available space.

Install Docker

Run the following command in the terminal to install Docker:

curl -fsSL https://get.docker.com | bash -s docker

Download the MCP Server

Clone the project repository using Git:

git clone https://github.com/your-repository/mcp-server.git
cd mcp-server

Configuration

Edit the Configuration File

Copy the example configuration file and make modifications:

cp config/mcp_servers.example.json config/mcp_servers.json
# Open config/mcp_servers.json with a text editor and make changes

Network Settings

Ensure that the server port (default 19132) is not occupied and that the firewall allows traffic on this port.

Start the Server

Start in Development Environment

# Run at the project root directory
npm start dev

Start in Production Environment

# Build the project and start
npm run build
npm start production

📚 Documentation

Directory Structure

The directory structure of the project is as follows:

.
├── config/                       # Configuration files
│   ├── mcp_servers.example.json  # Example configuration file
│   └── mcp_servers.json          # Production environment configuration file
├── logs/                         # Runtime logs
└── node_modules/                 # Project dependency packages

Network Configuration

Automatically Obtain the Internal Network IP

Run the script to detect the internal network IP:

node scripts/detect_host_ip.js

Configuration File Example

Edit the config/mcp_servers.json file to set server parameters:

{
  "servers": [
    {
      "name": "mcp-server",
      "type": "MCP",
      "host": "0.0.0.0",
      "port": 19132,
      "max_players": 20,
      "difficulty": "easy"
    }
  ]
}

🐳 Docker Support

Quick Deployment

Deploy the MCP server using Docker:

# Create a Docker image
FROM node:16

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

CMD ["node", "index.js"]

🤝 Contribution Guidelines

Submit Code

Before submitting code, make sure to:

npm test

🐞 Issue Reporting

If you encounter any issues, please visit our GitHub repository to submit an issue.

Thank you for using the MCP Server! If you need more help, please refer to the relevant documentation or contact the project maintainers.