Building from source

Building from source

You need Node.js 22 or newer and npm.

1. Clone the repository and install:

   git clone https://github.com/MairwunNx/minecraft-mcp
   cd minecraft-mcp
   npm install

   npm install also builds dist/.

2. Check it:

   npm run lint
   npm run typecheck
   npm test

3. Run your build against a server:

   WORLDAPI_URL=http://localhost:8110/api/v1 node dist/index.js --help

   To use it from a client, point the client's command at node and args at the full path of dist/index.js.

4. Pack the Claude Desktop bundle, if you need one:

   npm run pack:mcpb

   The bundle lands in build/.

Scripts

Script	What it does
npm run build	Compiles TypeScript into dist/.
npm run lint, npm run format	Checks, or fixes, style with Biome.
npm run typecheck	Type-checks without output.
npm test	Runs the Vitest suite against a mocked WorldAPI.
npm run generate	Regenerates the WorldAPI client (see Development).
npm run pack:mcpb	Packs build/minecraft-mcp-<version>.mcpb for Claude Desktop.

Next: Architecture.