Minecraft Bot Control

🚀 MCPMC (Minecraft Model Context Protocol)

A Model Context Protocol (MCP) server for interacting with Minecraft through Mineflayer. This package enables AI agents to control Minecraft bots via a standardized JSON - RPC interface.

🚀 Quick Start

The MCP server communicates using the model context protocol through stdin/stdout. To start the server, use the following command:

mcpmc

For detailed API documentation, use the MCP inspector:

bun run inspector

✨ Features

• Fully compatible with MCP, supporting AI agent integration.
• Built on the reliable Mineflayer library.
• Supports functions such as navigation, block operations, and inventory management.
• 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 Examples

Basic Usage

# Start the MCP server
mcpmc

Advanced Usage

# Use the MCP inspector to check detailed API documentation
bun run inspector

🔧 Technical Details

Development

# Install dependencies
bun install

# Run tests
bun test

# Build the project
bun run build

# Development mode
bun run watch

# Run the MCP inspector
bun run inspector

🤝 Contribution

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature.
3. Write tests for your changes.
4. Make the changes.
5. Run the tests and ensure they pass.
6. Submit a pull request.

Please make sure to update the relevant tests and follow the existing coding style.

📄 License

This project is under the MIT License.

Copyright (c) 2024 Gerred Dillon

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.