awesome-mineflayer-mcp

A production-ready Model Context Protocol server that gives an LLM agent standalone-equivalent control over a Mineflayer Minecraft bot — movement, mining, crafting, inventory, combat, containers, chat, and much more — exposed as 110 strongly-typed tools across 23 groups, with full bot lifecycle management and dual (poll + push) event streaming.

Backed by the Mineflayer ecosystem: mineflayer-pathfinder (A* navigation), mineflayer-pvp (combat), mineflayer-collectblock (gathering), mineflayer-tool (auto tool-select), mineflayer-auto-eat, and mineflayer-armor-manager.

Requirements

• Node.js ≥ 20 (developed on 22.16)

• A Minecraft server to connect to (Java Edition). The bot auto-detects the server version.

• For online-mode servers: a Microsoft account (auth: "microsoft").

Related MCP server: Minecraft Dedalus MCP

Installation

Run it on demand with npx (no install needed):

npx awesome-mineflayer-mcp

…or install it globally:

npm install -g awesome-mineflayer-mcp
awesome-mineflayer-mcp

The server speaks MCP over stdio, so it is normally launched by your MCP client rather than run by hand.

Use with an MCP client

Add it to your client's MCP server configuration. The recommended form uses npx so you always get the latest published build:

Claude Desktop (claude_desktop_config.json), Claude Code, Cursor, or any stdio MCP client:

{
  "mcpServers": {
    "mineflayer": {
      "command": "npx",
      "args": ["-y", "awesome-mineflayer-mcp"],
      "env": {
        "MCP_DISABLE_GROUPS": ""
      }
    }
  }
}

If you installed it globally, use "command": "awesome-mineflayer-mcp" with "args": [] instead.

Configuration (environment variables)

Example — disable rarely-used groups:

MCP_DISABLE_GROUPS=creative,villager,enchanting,settings

Quick start (tool flow)

1. connect_bot { host, username, auth } — required first; resolves once the bot spawns.

2. Act: goto, dig, collect_block, craft_item, pvp_attack, chat, …

3. Observe: poll get_events (pass the returned nextSince each time) and get_state; or subscribe to the bot://* resources.

4. disconnect_bot when done.

Block / item / entity arguments accept human names ("iron_ore", "diamond_pickaxe", "zombie"); unknown names return fuzzy suggestions.

Authentication

• auth: "offline" (default) — offline-mode servers; username is the in-game name.

• auth: "microsoft" — username is the account email. A device-code prompt is emitted as an msa_code event / log notification. Set profilesFolder to cache the token so subsequent runs skip the prompt, or pass a cached accessToken.

Tool catalog (110 tools, 23 groups)

Group keys (for MCP_DISABLE_GROUPS) are shown in brackets.

• Lifecycle [lifecycle] — connect_bot, disconnect_bot, reconnect_bot, respawn, get_connection_status

• State & inspection [state] (read-only) — get_state, get_inventory, list_players, list_entities, find_nearest_entity, get_entity_details, get_scoreboards, get_teams, get_boss_bars, get_control_states, get_chat_patterns, support_feature, pathfinder_status, get_settings, get_physics, get_loaded_plugins

• World queries [world] (read-only) — get_block_at, find_blocks, get_cursor_target, get_blocks_in_region, wait_for_chunks_to_load

• Movement & pathfinding [movement] — goto, set_goal, flee_from, follow_entity, stop_pathfinding, get_path_to, configure_movements, configure_pathfinder, set_control_state, clear_control_states, elytra_fly, wait_for_ticks, set_physics_enabled

• Look [look] — look_at, look, look_at_entity

• Digging & building [digging] — dig, place_block, activate_block, activate_entity, swing_arm

• Combat [combat] — pvp_attack, attack_entity, pvp_stop, pvp_configure

• Inventory & items [inventory] — equip_item, unequip_item, toss_item, set_quickbar_slot, consume, activate_item, click_window, move_slot_item, transfer_items

• Containers [containers] — open_container, read_open_container, container_deposit, container_withdraw, close_window

• Furnace / smelting [furnace] — open_furnace, furnace_action, furnace_status, smelt_item

• Enchanting & anvil [enchanting] — enchant_item, anvil_combine

• Villager trading [villager] — open_villager, trade_with_villager

• Crafting [crafting] — list_recipes, craft_item

• Block gathering [gathering] — collect_block, cancel_collect, set_collect_config

• Tool auto-select [tool] — equip_tool_for_block, set_tool_chest_locations, get_best_tool

• Survival automation [survival] — autoeat_set_enabled, autoeat_configure, autoeat_eat, autoeat_cancel, autoeat_preview, armor_equip_all

• Beds & sleep [beds] — sleep, wake

• Vehicles [vehicles] — mount_entity, dismount, steer_vehicle

• Fishing, books & signs [fishing] — fish, cancel_fish, write_book, update_sign

• Chat & communication [chat] — chat, whisper, run_command, tab_complete, register_chat_pattern, remove_chat_pattern, wait_for_message

• Settings [settings] — set_settings

• Creative mode [creative] — creative_set_inventory_slot, creative_clear_inventory, creative_fly, creative_fly_to

• Events & telemetry [events] — get_events, cancel_task

Long-running actions (goto, dig, collect_block, pvp_attack, fish, smelt_item, craft_item) are mutually exclusive and cancellable — start a new movement/combat action to supersede the prior one, or call stop_pathfinding / pvp_stop / cancel_collect / cancel_fish / cancel_task.

Resources

Subscribe-capable JSON resources for clients that support resource subscriptions:

• bot://state — live self snapshot (position, vitals, gamemode, time, weather, held item, control states)

• bot://inventory — items, armor, off-hand, held slot

• world://entities — up to 50 nearest tracked entities

• world://players — server roster

• bot://events — tail of recent events

Events

Game events are delivered two ways:

• Pull: get_events({ since, types, limit }) drains a ring buffer; pass the returned nextSince to read only new events. dropped: true signals the buffer overflowed since your since.

• Push: subscribed resources emit throttled notifications/resources/updated; notable lines (chat, death, kick, error, msa_code) are forwarded via sendLoggingMessage.

High-frequency observations (movement, per-tick updates, block/entity updates, time) are intentionally not buffered — read them on demand via get_state and the read-only tools.

Development (from source)

git clone https://github.com/G0Osey99/awesome-mineflayer-mcp.git
cd awesome-mineflayer-mcp
npm install
npm run build       # tsc -> dist/
npm run typecheck   # tsc --noEmit
npm test            # vitest (unit tests for the pure logic)
npm run dev         # tsx src/index.ts (run from source, no build step)

Architecture and the full design rationale: docs/superpowers/specs/2026-06-28-mineflayer-mcp-server-design.md.

src/
  index.ts        entry (stdio transport, graceful shutdown)
  server.ts       builds the McpServer, registers tool groups + resources
  config.ts       env + constants
  bot/            manager (lifecycle FSM), plugins, events, wire-events, state, windows, action-locks
  tools/          one module per tool group (+ registry.ts)
  resources/      MCP resources + push notifications
  util/           errors, format, result, resolve (name→id + fuzzy), serialize
  schemas/        shared Zod fragments

Publishing (maintainers)

npm version patch        # or minor / major — bumps package.json + tags
npm publish              # the `prepare` script builds dist/ first; publishes to npm
git push --follow-tags

The published package ships only dist/, README.md, and LICENSE (see the files field).

Limitations

• One bot per server process (single-session by design).

• Evaluations require a seeded world. A live Minecraft world is not deterministic, so the evaluation set in eval/ targets a documented seeded fixture (see eval/fixture.md); it cannot be verified against an arbitrary live server.

• cancel_fish is best-effort (Mineflayer exposes no first-class fishing abort).

• Microsoft auth's first run needs an interactive device code (surfaced as an msa_code event); use profilesFolder to cache it.

License

MIT