🚀 MCPMC（Minecraft 模型上下文协议）

一个用于通过 Mineflayer 与 Minecraft 交互的模型上下文协议 (MCP) 服务器。此包能让 AI 代理通过标准化的 JSON - RPC 接口控制 Minecraft 机器人，为 AI 与 Minecraft 的交互提供了便捷途径。

🚀 快速开始

此包能让 AI 代理借助标准化的 JSON - RPC 接口控制 Minecraft 机器人，以下是使用前的安装和启动步骤。

✨ 主要特性

• 完全兼容 MCP，支持 AI 代理集成，为 AI 与 Minecraft 的交互提供了标准化的接口。
• 基于可靠的 Mineflayer 库构建，确保系统的稳定性和可靠性。
• 支持导航、方块操作、库存管理等功能，满足多样化的游戏操作需求。
• 实时游戏状态监控，让用户随时了解游戏的最新情况。
• 类型安全的 API 并附带 TypeScript 支持，提高开发效率和代码质量。

📦 安装指南

你可以根据自己的需求选择以下任意一种方式进行安装：

# 使用 npm
npm install @gerred/mcpmc

# 使用 yarn
yarn add @gerred/mcpmc

# 使用 bun
bun add @gerred/mcpmc

💻 使用示例

基础用法

启动 MCP 服务器：

mcpmc

该服务器通过 stdin/stdout 使用模型上下文协议进行通信。

高级用法

若你需要查看详细 API 文档，请使用 MCP 检查器：

bun run inspector

📚 详细文档

开发流程

# 安装依赖项
bun install

# 运行测试
bun test

# 构建项目
bun run build

# 开发模式
bun run watch

# 运行 MCP 检查器
bun run inspector

贡献指南

欢迎贡献！请按照以下步骤操作：

1. 叉出仓库
2. 为你的功能创建新分支
3. 为你更改编写测试
4. 进行更改
5. 运行测试并确保它们通过
6. 提交拉取请求

请务必更新相关测试，并遵守现有的编码风格。

📄 许可证

本项目采用 MIT 许可证。

版权所有 (c) 2024 Gerred Dillon

特此授权，任何获得本软件及其关联文档文件副本的人（“软件”），可以在不受限制的条件下使用、复制、修改、合并、发布、分发、 sublicense 和/或出售 该软件的副本，并允许向其提供该软件的人按以下条件行事：

上述版权声明和本许可声明应包含在所有副本或实质性部分中。

软件是“按原样”提供的，不做任何形式的担保，包括但不限于对适销性、特定用途的适用性和非侵权性的明示或暗示保证。在因合同、侵权或其他行为导致的任何主张、损害或其他责任中，作者或版权持有人不承担任何责任。

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.