Rimworld MCP Server

RimWorld改装MCP

用于RimWorld mod分析和moding工作流的MCP服务器，用C#/实现。网10。

主要关注点：

• XML定义和继承
• 补丁检查和冲突分类
• mod兼容性和依赖性检查
• Player.log分类
• RimWorld模组的发布准备检查

快速启动

推荐：全球 .NET tool

需要a .NET 10 SDK.

dotnet tool install -g cryptiklemur.rimworld-modder-mcp

然后，大多数MCP客户端可以使用：

{
  "mcpServers": {
    "rimworld-modder": {
      "command": "rimworld-modder-mcp",
      "args": [
        "--rimworld-path=/absolute/path/to/RimWorld",
        "--mod-dirs=/absolute/path/to/RimWorld/Mods"
      ]
    }
  }
}

回购示例：

• claude-desktop-config.json
• local-mcp-config.json

推荐：repo本地配置

创建 .rimworld-modder-mcp.json 在你的mod仓库中：

{
  "rimworldPath": "/absolute/path/to/RimWorld",
  "modDirs": [
    "/absolute/path/to/RimWorld/Mods",
    "/absolute/path/to/Steam/workshop/content/294100"
  ],
  "logPath": "/absolute/path/to/Player.log",
  "allowedDlcs": "Core,Biotech",
  "outputMode": "compact"
}

那么你的MCP客户端参数可以是：

{
  "mcpServers": {
    "rimworld-modder": {
      "command": "rimworld-modder-mcp",
      "args": [
        "--project-root=/absolute/path/to/your/mod/repo"
      ]
    }
  }
}

无安装选项

如果您不希望进行全局安装，请使用 dnx 或 dotnet tool exec这也需要 .NET 10 SDK.

直接使用shell：

dnx cryptiklemur.rimworld-modder-mcp --yes -- --project-root=/absolute/path/to/your/mod/repo

dotnet tool exec cryptiklemur.rimworld-modder-mcp --yes -- --project-root=/absolute/path/to/your/mod/repo

无头MCP配置 dnx:

{
  "mcpServers": {
    "rimworld-modder": {
      "command": "dnx",
      "args": [
        "cryptiklemur.rimworld-modder-mcp",
        "--yes",
        "--",
        "--project-root=/absolute/path/to/your/mod/repo"
      ]
    }
  }
}

--yes 是不是第一次运行包下载不会暂停以进行确认。

客户端设置

选择你关心的客户：

Codex CLI

全局安装的工具：

codex mcp add rimworld-modder -- \
  rimworld-modder-mcp \
  --project-root=/absolute/path/to/your/mod/repo

不安装：

codex mcp add rimworld-modder -- \
  dnx cryptiklemur.rimworld-modder-mcp \
  --yes \
  -- \
  --project-root=/absolute/path/to/your/mod/repo

Claude Code

全局安装的工具：

claude mcp add --scope user rimworld-modder -- \
  rimworld-modder-mcp \
  --project-root=/absolute/path/to/your/mod/repo

不安装：

claude mcp add --scope user rimworld-modder -- \
  dnx cryptiklemur.rimworld-modder-mcp \
  --yes \
  -- \
  --project-root=/absolute/path/to/your/mod/repo

Goose CLI

使用已安装的工具进行快速会话：

goose session \
  --with-extension "rimworld-modder-mcp --project-root=/absolute/path/to/your/mod/repo"

无需安装即可快速会话 dnx:

goose session \
  --with-extension "dnx cryptiklemur.rimworld-modder-mcp --yes -- --project-root=/absolute/path/to/your/mod/repo"

对于持久的Goose设置，请使用 goose configure 并添加命令行扩展。

Claude Desktop, Cursor, Cline, Windsurf, Continue

如果客户端公开stdio MCP配置，请使用以下任一方法：

• command: "rimworld-modder-mcp" 随着 --project-root=/absolute/path/to/your/mod/repo
• command: "dnx" 上面显示的是无安装块

仅运行时回退

如果你只想要运行时，请使用发布包而不是NuGet工具。

1. 安装 .NET 10运行时.
2. 下载最新 rimworld-modder-mcp-vX.Y.Z-dotnet.zip 从 .
3. 把它提取到一个永久的地方。
4. 将您的MCP客户端指向 RimWorldModderMcp.dll.

捆绑配置：

{
  "mcpServers": {
    "rimworld-modder": {
      "command": "dotnet",
      "args": [
        "/absolute/path/to/RimWorldModderMcp.dll",
        "--rimworld-path=/absolute/path/to/RimWorld",
        "--mod-dirs=/absolute/path/to/RimWorld/Mods"
      ]
    }
  }
}

每个捆绑包还包括：

• manifest.json
• QUICKSTART.md
• examples/generic-mcp-config.posix.json
• examples/generic-mcp-config.windows.json

码头工人

构建：

docker build -t rimworld-modder-mcp .

运行：

docker run \
  -i \
  --rm \
  -v "/path/to/rimworld:/rimworld:ro" \
  -v "/path/to/workshop:/workshop:ro" \
  rimworld-modder-mcp \
  --rimworld-path=/rimworld \
  --mod-dirs=/rimworld/Mods,/workshop

MCP配置：

{
  "mcpServers": {
    "rimworld-modder": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v", "/path/to/rimworld:/rimworld:ro",
        "-v", "/path/to/workshop:/workshop:ro",
        "ghcr.io/cryptiklemur/rimworld-modder-mcp:latest",
        "--rimworld-path=/rimworld",
        "--mod-dirs=/rimworld/Mods,/workshop"
      ]
    }
  }
}

参数

常见可选：

• --project-root 用于配置发现和相对路径解析的repo根
• --config 明确的项目配置路径
• --rimworld-path 如果不使用项目配置，则指向RimWorld安装的路径
• --mod-dirs 逗号分隔的mod目录
• --mods-config-path 通往 ModsConfig.xml 如果你只想启用mods
• --logPath 通往 Player.log
• --allowedDlcs 兼容性检查的官方内容目标，默认 Core,Biotech
• --log-level Debug, Information, Warning，或 Error
• --scopeType 和 --scopeValue 为了 audit_scope

常见的RimWorld路径：

• Windows Steam： D:\SteamLibrary\steamapps\common\RimWorld
• Linux Steam： ~/.steam/steam/steamapps/common/RimWorld
• macOS Steam： ~/Library/Application Support/Steam/steamapps/common/RimWorld

跑 rimworld-modder-mcp --help 查看完整的参数列表。

输出控制

• outputMode: compact, normal，或 detailed
• pageSize：帽阵列重型部分
• pageOffset：遍历数组密集的部分
• handleResults：存储可检索的结果句柄
• get_result_by_handle：展开长期MCP会话中存储的句柄

核心工作流工具

在大多数mod repos中从这里开始：

• 设置和环境： doctor
• 提交前更改文件审查： audit_changed_files, validate_changed_content
• 运行时调试： triage_player_log, compare_player_logs, broken_reference_explainer
• 放行/准备就绪检查： mod_ready_check, scan_dlc_dependencies
• 补丁调试： triage_patch_conflicts, find_patch_hotspots, validate_xpath, write_xpath, preview_patch, preview_patch_result
• 检查范围： scope_search, audit_scope, content_coverage_report
• 加载顺序影响： suggest_load_order, load_order_impact_report

当您需要确切的详细信息时，低级查找工具仍然可用：

• Def查找： get_def, search_defs, get_defs_by_type, get_def_inheritance_tree, compare_defs
• 参考文献和补丁： get_references, get_def_dependencies, get_patches_for_def, get_patch_conflicts
• 模态分析： analyze_mod_compatibility, get_mod_dependencies, find_broken_references, validate_mod_structure

您的MCP客户端可以直接查看完整的工具列表。

从源代码构建

git clone https://github.com/cryptiklemur/rimworld-modder-mcp.git
cd rimworld-modder-mcp
dotnet build src/RimWorldModderMcp/RimWorldModderMcp.csproj
dotnet run --project src/RimWorldModderMcp/RimWorldModderMcp.csproj -- --rimworld-path="/path/to/RimWorld"

发布

semantic-release 出版：

• NuGet .NET tool
• 这 .nupkg 作为GitHub发布资产
• 仅运行时压缩包
• 这 .sha256 校验和

nuget.org上的可信发布：

1. 在nuget.org中，打开 Trusted Publishing.
2. 为以下项目添加GitHub操作策略：

- 存储库所有者： cryptiklemur - 存储库： rimworld-modder-mcp - 工作流文件： release.yml

1. 在GitHub仓库设置中，添加一个仓库变量：

- NUGET_USERNAME =您的nuget.org个人资料名称

在此之后，不需要长期使用NuGet API密钥机密。

有用的命令：

npm ci
npm run release:dry-run
npm run release:prepare-artifacts -- 1.2.5

CI配置：

• NuGet可信发布通过 NuGet/login@v1
• 回购变量 NUGET_USERNAME
• SEMANTIC_RELEASE_TOKEN 如果你想发布创建的标签来触发其他工作流