Rust MCP Schema

🚀 Rust MCP Schema Project Documentation

rust-mcp-schema is a Rust library that provides MCP (the official decompiler for MineCraft Forge) schema support for Minecraft Bedrock Edition (BE) and Java Edition (JE). This library aims to assist developers in more easily handling in-game data structures and protocols in Minecraft.

✨ Features

• MCP Schema Support: The library fully implements the definition of the MCP Schema format, allowing users to describe in-game types in Minecraft through readable JSON files.
• Automatic Rust Type Generation: Based on the MCP Schema, the library can generate corresponding Rust data structures, making the handling of Minecraft data more intuitive and efficient.
• Decompiler Support: It provides the ability to parse data output by the Minecraft decompiler, helping developers analyze and understand the internal working mechanisms of the game.

💻 Usage Examples

Basic Usage

{
    "type": "object",
    "name": "Position",
    "fields": [
        { "type": "int", "name": "x" },
        { "type": "int", "name": "y" },
        { "type": "int", "name": "z" }
    ]
}

The generated Rust struct:

#[derive(Debug, Clone)]
pub struct Position {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

Advanced Usage

Suppose we have a data file after MCP decompilation, for example:

{
    "id": 15,
    "jsonrpc": "2.0",
    "result": {
        "capabilities": {
            "prompts": { "listChanged": true },
            "resources": { "listChanged": true, "subscribe": true },
            "tools": { "listChanged": true }
        },
        "instructions": "mcp server instructions....",
        "_meta": { "feature-xyz": true, "meta 1": "meta-value", "meta 2": 225 },
        "protocolVersion": "2024-11-05",
        "serverInfo": {
            "name": "example-servers/everything",
            "version": "1.0.0"
        }
    }
}

Use rust-mcp-schema to parse it:

let json_payload = message.to_string();
// Parse JSON data
let mcp_message: JsonrpcMessage = serde_json::from_str(&json_payload)?;

match mcp_message {
    JsonrpcMessage::Response(response) => {
        // Process response data
        if let Some(server_info) = response.result.serverInfo {
            println!("Server name: {}", server_info.name);
            println!("Server version: {}", server_info.version);
        }
    },
    _ => {}
}

🤝 Contribution Guidelines

We welcome contributions from the community! If you have any questions or suggestions, please feel free to submit Issues or Pull Requests.

Requirements before submitting code:

1. Format Check: Ensure that all Rust code follows Rust's coding conventions (e.g., cargo fmt --all).
2. Unit Testing: Run all unit tests in the project before submitting code to ensure that no errors are introduced.
3. Documentation Update: If your changes affect the API or functionality, please update the relevant documentation and comments accordingly.

📁 Project Structure

• schemas: Contains the definition files for the MCP Schema.
• src: Contains the core implementation of the Rust library, including modules such as decompiler support and type generation.
• examples: Provides some usage examples to help users understand how to use the library.
• Cargo.toml: Project dependency management and build configuration.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

Thank you for your interest in and support for rust-mcp-schema! We hope this library can provide convenience for Minecraft developers and promote the development of the community.