📌Overview

Purpose: To facilitate interaction between AI agents and Minecraft bots through a standardized JSON-RPC interface using the Model Context Protocol.

Overview: MCPMC serves as a server built on Mineflayer that provides comprehensive tools for controlling Minecraft bots, allowing for advanced AI agent integrations and real-time interactions within the game environment.

Key Features:

Full MCP Compatibility: Ensures seamless integration of AI agents, enabling them to communicate and control Minecraft entities effectively.
Mineflayer Foundation: Leverages Mineflayer for stable and reliable interaction with Minecraft, enhancing the bot's capabilities.
Robust Functionality: Supports essential bot functions such as navigation, block manipulation, and inventory management, broadening the scope of what can be automated within the game.
Real-Time Monitoring: Allows for continuous observation of game states, which is critical for dynamic decision-making by AI agents.
Type-Safe API: Offers TypeScript support for a type-safe development experience, reducing errors and enhancing code quality.

MCPMC (Minecraft Model Context Protocol)

MCPMC is a Model Context Protocol (MCP) server that allows interaction with Minecraft through Mineflayer. This package enables AI agents to control Minecraft bots via a standardized JSON-RPC interface.

Features

Full MCP compatibility for AI agent integration
Built on Mineflayer for reliable Minecraft interaction
Supports navigation, block manipulation, inventory management, and more
Real-time game state monitoring
Type-safe API with TypeScript support

Installation

# Using npm
npm install @gerred/mcpmc

# Using yarn
yarn add @gerred/mcpmc

# Using bun
bun add @gerred/mcpmc

Usage

# Start the MCP server
mcpmc

The server communicates via stdin/stdout using the Model Context Protocol. For detailed API documentation, use the MCP inspector:

bun run inspector

Development

# Install dependencies
bun install

# Run tests
bun test

# Build the project
bun run build

# Watch mode during development
bun run watch

# Run MCP inspector
bun run inspector

Contributing

Contributions are welcome! Please follow these steps:

Fork the repository
Create a new branch for your feature
Write tests for your changes
Make your changes
Run tests and ensure they pass
Submit a pull request

Please make sure to update tests as appropriate and adhere to the existing coding style.

License

MIT License (2024 Gerred Dillon)

Permission is granted to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, subject to copyright notice inclusion. The Software is provided "as is", without warranty of any kind.