RimSearcher

RimSearcher is a powerful Model Context Protocol (MCP) server designed specifically for fast searching and retrieval of RimWorld source code. Developers can leverage this server to efficiently query and navigate through the game's extensive codebase, making it easier to find specific functions, classes, or assets relevant to their modding or development projects. With its optimized search capabilities, RimSearcher can significantly enhance your productivity when working with RimWorld's source code.

Once connected to the RimSearcher MCP server, you can issue various search queries to retrieve specific pieces of RimWorld source code. You can use commands for searching by keywords, classes, or functions. For optimal results, start your queries with specific terms related to the code you need, such as the name of a class or method. For instance, a command like search("Pawn") will help you find all relevant references to the Pawn class in the codebase.

To get started with RimSearcher, ensure you have the following prerequisites installed:

• Node.js (version 14.x or later)
• A compatible terminal or command line interface

Option A: Quick start with npx

If you prefer a quick start, you can use the following command:

npx -y kearril/rimsearcher  

Option B: Global install alternative

Alternatively, you can install RimSearcher globally using npm:

npm install -g kearril/rimsearcher  

After installation, you can run the server using the command rimsearcher in your terminal.

When configuring RimSearcher, consider setting environment variables to customize your search settings and performance options. You may also want to ensure your terminal has the necessary permissions to access the game's source code directory. A common issue is related to insufficient read permissions, so verify that your user account has access to the required files.