RimSage README

The full upstream README, mirrored for reference. Install config, tool schemas, adoption signals and our own overview live on the RimSage listing page.

RimSage

MCP Server bun ripgrep

An MCP server that provides RimWorld source code search and browsing capabilities.

Available Tools

The server provides these tools:

  • search_source - Search RimWorld source code
  • read_file - Read specific files
  • list_directory - List directory contents
  • search_defs - Search through RimWorld Defs
  • get_def_details - Get raw or merged RimWorld Def XML
  • read_csharp_symbol - Read a C# type or method definition

Quick Start

The easiest way to use RimSage is through the online service:

Code
https://mcp.rimsage.com/mcp

You can find the integration methods for different Agent clients in the wiki.

Self-Hosted

RimSage also supports stdio transport for local deployment.

  1. Install dependencies
  1. Clone the repository
sh
git clone https://github.com/realloon/RimSage.git
  1. Install package dependencies
sh
bun install
  1. Build index
sh
bun run import:defs /path/to/your/rimworld/root/path
bun run import:csharp /path/to/decompiled/source/root/path
bun run build

You'll need local RimWorld files and a decompiled C# project, which is allowed under the RimWorld EULA.

  1. Add this MCP server

You can find the integration methods for different Agent clients in the wiki.

Most Agent clients support mcp.json configuration:

config.json
{
  "mcpServers": {
    "rimsage": {
      "command": "bun",
      "args": ["run", "/path/to/this/repo"]
    }
  }
}

Replace /path/to/this/repo with the actual path to this repository on your system.

Development

sh
bun run start # stdio
bun run start:http # Streamable HTTP