mcpkg

mcpkg-server implements the MCP (Minecraft Package) management API for the mcpkg project. It serves as the runtime for managing Minecraft packages, allowing clients to query available packages, install or update packages into a Minecraft environment, and manage package metadata. To run the server locally, start the server process (in this setup it is started as a Node.js application via node server.js). Once running, you can interact with it using the MCP API endpoints exposed by the server (e.g., endpoints for listing packages, installing a package, and retrieving package details). The included build/test flow (see Makefile) is used during development to compile assets and verify the server works as expected. When the server is running, typical operations include: listing available mcpkg packages, installing a chosen package into the Minecraft environment, and querying package metadata or version history.

Prerequisites:

• Node.js and npm installed on your system
• A working Makefile setup for build/test (as per repository)

Installation steps:

1. Clone the repository: git clone https://github.com/your-org/mcpkg.git cd mcpkg

2. Install dependencies (if package.json exists): npm install

3. Build the server (as per repository guidance): make build

4. (Optional) Run tests to verify: make test

5. Start the server (as per the server entry point): node server.js

Notes:

• If the project uses a different entry point or a Docker image, adjust the start command accordingly.
• Ensure any required environment variables (e.g., for authentication or package repositories) are set before starting the server.

Tips and common issues:

• If make build or make test fails, ensure all build tools (compilers, SDKs) required by the Makefile are installed on your system.
• Check for environment variables needed for package sources, authentication, or Minecraft environment configuration and document them in your env block.
• If using a containerized setup, expose the appropriate ports and mount any necessary data volumes for package storage.
• When upgrading, verify compatibility of package metadata with the server API version.
• The server exposes endpoints for listing, installing, and querying packages; refer to the API docs or source comments for exact paths and payload schemas.