Skip to main content

​
Purpose

This page gives you the full MineClawd configuration model, including file settings, command keys, and restart behavior.

​
Where settings live

  • Global config file: config/mineclawd.json5
  • Per-player chat visibility: mineclawd/player-settings.json
  • Soul files and active soul state: mineclawd/souls/ and mineclawd/souls/.active/

​
Complete mineclawd.json5 template

{
  provider: "OPENAI",
  endpoint: "https://api.openai.com/v1",
  apiKey: "",
  model: "gpt-5.2",
  summarizeModel: "gpt-5.2",

  vertexEndpoint: "https://aiplatform.googleapis.com/v1",
  vertexApiKey: "",
  vertexModel: "gemini-3.1-pro-preview",
  vertexSummarizeModel: "gemini-3-flash-preview",

  tavilyApiKey: "",

  debugMode: false,
  limitToolCalls: false,
  toolCallLimit: 16,
  systemPrompt: "",
  dynamicRegistryMode: "AUTO",

  // Client-only (not in server config file)
  enableGui: true
}
In file form, enum values are uppercase (OPENAI, VERTEX_AI, AUTO, ENABLED, DISABLED).In command form, values are lowercase (openai, vertex-ai, auto, enabled, disabled).

​
Key reference

File keyCommand keyTypeDefaultNotes
providerproviderenumOPENAIProvider selection: OpenAI-compatible or Vertex AI.
endpointendpointstringhttps://api.openai.com/v1OpenAI-compatible base URL, no trailing slash required.
apiKeyapi-keystringemptyOpenAI API key.
modelmodelstringgpt-5.2OpenAI chat model.
summarizeModelsummarize-modelstringgpt-5.2OpenAI model for first-turn session title generation.
vertexEndpointvertex-endpointstringhttps://aiplatform.googleapis.com/v1Vertex API base URL.
vertexApiKeyvertex-api-keystringemptyVertex API key.
vertexModelvertex-modelstringgemini-3.1-pro-previewVertex model path or model name.
vertexSummarizeModelvertex-summarize-modelstringgemini-3-flash-previewVertex summarize model for session titles.
tavilyApiKeytavily-api-keystringemptyTavily API key for web search. When set, enables the search tool.
debugModedebug-modebooleanfalseLogs detailed request and tool activity.
limitToolCallslimit-tool-callsbooleanfalseEnables per-request tool-loop cap.
toolCallLimittool-call-limitinteger16Allowed range is 1 to 20.
systemPromptsystem-promptstringemptyEmpty means built-in system prompt. Use value default in command mode to reset.
dynamicRegistryModedynamic-registry-modeenumAUTOControls dynamic placeholder runtime mode. Restart required after change.
enableGui—booleantrueClient-only. Show or hide the overlay GUI. Set through Mod Menu -> MineClawd -> Configure.

​
Per-player settings

​
broadcast-requests-to

Command-only, per-player.
  • Command key: broadcast-requests-to
  • Allowed values: self, all, ops
  • Stored in: mineclawd/player-settings.json
  • Purpose: controls who sees prompt echo and task start or finish lines.

​
assistivetouch

Toggle-only, per-player.
  • Command: /mineclawd assistivetouch
  • Stored in: mineclawd/player-settings.json
  • Default: enabled (visible)
  • Purpose: show or hide the floating AssistiveTouch orb without disabling the full GUI.

​
Dynamic registry mode behavior

  • AUTO: enabled in client runtime (single-player), disabled on dedicated servers.
  • ENABLED: force enabled in all runtimes.
  • DISABLED: fully disabled.
If you force ENABLED on a dedicated server, joining clients must have MineClawd installed.

​
Baseline for first-time OpenAI setup

/mineclawd config provider openai
/mineclawd config endpoint https://api.openai.com/v1
/mineclawd config api-key <your-key>
/mineclawd config model gpt-5.2
/mineclawd config summarize-model gpt-5.2

​
Baseline for first-time Vertex setup

/mineclawd config provider vertex-ai
/mineclawd config vertex-endpoint https://aiplatform.googleapis.com/v1
/mineclawd config vertex-api-key <your-key>
/mineclawd config vertex-model gemini-3.1-pro-preview
/mineclawd config vertex-summarize-model gemini-3-flash-preview

​
GUI path

  • In game: Mod Menu -> MineClawd -> Configure
  • Command fallback: /mineclawd config ...
  • Overlay menu: click the hamburger icon -> Config
If client GUI open fails, configure through command keys.
The enableGui setting controls the overlay window. Setting it to OFF does not affect the YACL config screen — you can still open config through Mod Menu or /mineclawd config.