rimsage
v1.0.1
Published
An MCP server that enables searching and browsing of RimWorld source code.
Readme
RimSage
An MCP server that provides RimWorld source code search and browsing capabilities.
Available Tools
The server provides these tools:
search_source- Search RimWorld source coderead_file- Read specific fileslist_directory- List directory contentssearch_defs- Search through RimWorld Defsget_def_details- Get raw or merged RimWorld Def XMLread_csharp_symbol- Read a C# type or method definition
Quick Start
The easiest way to use RimSage is through the online service:
https://mcp.rimsage.com/mcpYou can find the integration methods for different Agent clients in the wiki.
Self-Hosted
RimSage also supports stdio transport for local deployment.
- Install dependencies
- Clone the repository
git clone https://github.com/realloon/RimSage.git- Install package dependencies
bun install- Build index
bun run src/scripts/import-defs /path/to/your/rimworld/root/path
bun run src/scripts/import-csharp /path/to/decompiled/source/root/path
bun run buildYou'll need local RimWorld files and a decompiled C# project, which is allowed under the RimWorld EULA.
- Add this MCP server
You can find the integration methods for different Agent clients in the wiki.
Most Agent clients support mcp.json configuration:
{
"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
bun run start # stdio
bun run start:http # Streamable HTTP