MCPunk

Configures and searches codebases by chunking files and querying chunks with auditable, context-rich tools.

typescript

55

GitHub Stars

typescript

Language

4 months ago

First Indexed

3 weeks ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "jurasofish-mcpunk": {
      "command": "uvx",
      "args": [
        "mcpunk"
      ],
      "env": {
        "MCPUNK_INCLUDE_CHARS_IN_RESPONSE": "false"
      }
    }
  }
}

MCPunk is a flexible RAG tool that lets you chat with your codebase by exposing the code through searchable chunks. You connect a client, configure a project, and then ask questions about files, functions, or diffs. It emphasizes clear, auditable searching without embeddings, so you can see exactly what the model is using to answer.

How to use

You use MCPunk with an MCP client to interactively query your configured projects. Start by configuring a project, then use the built-in tools to explore files, chunks, and diffs. You can guide the LLM by requesting specific actions or asking it to list files, fetch chunk contents, or show diffs between branches.

How to install

Prerequisites: ensure you have the MCP runtime available in your environment and that you can run the MCPunk server container or process as shown in the configuration example.

Install the MCPunk runtime (the example uses a command named uvx). The exact installation method is shown in your setup steps.
Add the MCPunk server configuration to your MCP client configuration. Use the snippet below to point the client to MCPunk.

{
  "mcpServers": {
    "MCPunk": {
      "command": "uvx",
      "args": ["mcpunk"]
    }
  }
}

Configuration and usage notes

To configure MCPunk with your project, place the following snippet in your client’s configuration file and restart the client so the new tools become available after a short delay.

{
  "mcpServers": {
    "MCPunk": {
      "command": "uvx",
      "args": ["mcpunk"]
    }
  }
}

Environment variables and runtime notes

You can control how the MCPunk client and server behave using environment variables. For example, you can customize the response length behavior by setting MCPUNK_INCLUDE_CHARS_IN_RESPONSE to false.

{
  "mcpServers": {
    "MCPunk": {
      "command": "uvx",
      "args": ["mcpunk"],
      "env": {
        "MCPUNK_INCLUDE_CHARS_IN_RESPONSE": "false"
      }
    }
  }
}

Available tools

configure_project

Configure a project by specifying its root path and a name so MCPunk can scan, chunk, and index its files for querying.

list_all_files_in_project

Return a list of all files that MCPunk has scanned within the configured project, organized by their file paths.

find_files_by_chunk_content

Search for files containing chunks that match the provided text, returning the files that have relevant content.

find_matching_chunks_in_file

Within a specific file, locate chunks that contain the search term and return their identifiers.

chunk_details

Fetch the full content of a particular chunk identified by its ID, along with contextual metadata like the file path and chunk type.

list_most_recently_checked_out_branches

Parse the project's git reflog and return the most recently checked-out branches, helping you identify branches for diffs.

diff_with_ref

Generate a git diff between the current HEAD and a specified reference branch for the configured project.