// documentation

Getting started

Install mcwrench in your AI runtime, make your first natural-language ask, and save a server profile so answers stop re-asking the basics.

Install per runtime

mcwrench ships as a Claude Code plugin and as portable Agent Skills. Skills are filesystem-based and do not sync across runtimes, so install it in each surface you use. Pick your runtime below.

Claude Code

Add the marketplace, then install the plugin from inside a claude session. Skills auto-trigger and you get the /mcwrench:* slash aliases.

Gemini CLI

Clone the repo and launch gemini from its root. GEMINI.md and AGENTS.md load as context and point Gemini at the skill playbooks.

Codex / Antigravity

Clone and open the repo. Both discover skills from .agents/skills/ (a symlink to skills/) and read guidance from AGENTS.md, so the skills auto-load.

Claude.ai

Pack the skills, then in Claude.ai go to Customize, then Skills, then Create skill, then Upload the zip. Requires code execution enabled.

Note. On Codex and Antigravity the symlink resolves automatically on Linux and macOS. On Windows, run node scripts/setup-symlinks.mjs after cloning if it does not resolve locally.

Your first ask

You do not have to name a skill or learn a command. The always-on minecraft-server-router engages on any server-admin topic and hands off to the right specialist (audit, performance, permissions, and the rest). Just describe the problem in plain words and the matching skill triggers.

Example asks

On Claude Code, Gemini CLI, and Antigravity you can also use the slash forms. On Claude.ai and Codex there are no custom slash commands, so plain phrasing is the way in. The skill descriptions are written to catch it.

Save a server profile

Point the scanner at your server root with --write-profile and it writes skills/_cache/server-profile.json. Every skill reads this first, so later answers stop re-asking your version, host, and stack. The scan is read-only on your server tree; only the profile file inside mcwrench's own cache is written.

What it captures

  • ▸software and mcVersion, detected from the server jar and config files.
  • ▸gamemode, proxy, and onlineMode, inferred from the plugin set and key settings.
  • ▸plugins, worlds, and chatFormatter, read from the tree.
  • ▸java, host, and ramMB, which are not auto-detected and start empty. Set them manually.
Note. The auto-detected mcVersion is best-effort, parsed off the server jar name, so confirm it before relying on version-specific advice. The java, host, and ramMB values are always set by hand.

Read and edit the profile

Use server-profile.mjs to show, read, set, or clear the saved values. Running it with no command prints the current profile.

Tips for sharper answers

  • ▸Name your version, software, and host. "Paper 26.1.2 on Pterodactyl, 8 GB" gets a sharper answer than "my server".
  • ▸Share a Spark report URL for lag questions. It is the evidence the performance advice is built on.
  • ▸Ask about an unfamiliar plugin anyway. mcwrench fetches and condenses its real docs before answering, so it does not guess at config keys.
  • ▸It will refuse known footguns, like mixing G1 and ZGC flags, running two claims plugins, or two skyblock engines. Those are not preferences.
← OverviewCommands →