MCP Server

Repomix supports the Model Context Protocol (MCP), allowing AI assistants to directly interact with your codebase. When run as an MCP server, Repomix provides tools that enable AI assistants to package local or remote repositories for analysis without requiring manual file preparation.

NOTE

This is an experimental feature that we'll be actively improving based on user feedback and real-world usage

Running Repomix as an MCP Server

To run Repomix as an MCP server, use the --mcp flag:

repomix --mcp

This starts Repomix in MCP server mode, making it available for AI assistants that support the Model Context Protocol.

Available MCP Tools

When running as an MCP server, Repomix provides the following tools:

pack_codebase

This tool packages a local code directory into a consolidated file for AI analysis.

Parameters:

• directory: (Required) Absolute path to the directory to pack
• compress: (Optional, default: true) Whether to perform intelligent code extraction to reduce token count
• includePatterns: (Optional) Comma-separated list of include patterns
• ignorePatterns: (Optional) Comma-separated list of ignore patterns

Example:

{
  "directory": "/path/to/your/project",
  "compress": true,
  "includePatterns": "src/**/*.ts,**/*.md",
  "ignorePatterns": "**/*.log,tmp/"
}

pack_remote_repository

This tool fetches, clones, and packages a GitHub repository into a consolidated file for AI analysis.

Parameters:

• remote: (Required) GitHub repository URL or user/repo format (e.g., yamadashy/repomix)
• compress: (Optional, default: true) Whether to perform intelligent code extraction to reduce token count
• includePatterns: (Optional) Comma-separated list of include patterns
• ignorePatterns: (Optional) Comma-separated list of ignore patterns

Example:

{
  "remote": "yamadashy/repomix",
  "compress": true,
  "includePatterns": "src/**/*.ts,**/*.md",
  "ignorePatterns": "**/*.log,tmp/"
}

read_repomix_output

This tool reads the contents of a Repomix output file in environments where direct file access is not possible.

Parameters:

• outputId: (Required) ID of the Repomix output file to read

Features:

• Specifically designed for web-based environments or sandboxed applications
• Retrieves the content of previously generated outputs using their ID
• Provides secure access to packed codebase without requiring file system access

Example:

{
  "outputId": "8f7d3b1e2a9c6054"
}

file_system_read_file and file_system_read_directory

Repomix's MCP server provides two file system tools that allow AI assistants to safely interact with the local file system:

1. file_system_read_file

   • Reads file contents using absolute paths
   • Implements security validation using Secretlint
   • Prevents access to files containing sensitive information
   • Returns formatted content with clear error messages for invalid paths or security issues

2. file_system_read_directory

   • Lists directory contents using absolute paths
   • Shows both files and directories with clear indicators ([FILE] or [DIR])
   • Provides safe directory traversal with proper error handling
   • Validates paths and ensures they are absolute

Both tools incorporate robust security measures:

• Absolute path validation to prevent directory traversal attacks
• Permission checks to ensure proper access rights
• Integration with Secretlint for sensitive information detection
• Clear error messaging for better debugging and security awareness

Example:

// Reading a file
const fileContent = await tools.file_system_read_file({
  path: '/absolute/path/to/file.txt'
});

// Listing directory contents
const dirContent = await tools.file_system_read_directory({
  path: '/absolute/path/to/directory'
});

These tools are particularly useful when AI assistants need to:

• Analyze specific files in the codebase
• Navigate directory structures
• Verify file existence and accessibility
• Ensure secure file system operations

Configuring MCP Servers

To use Repomix as an MCP server with AI assistants like Claude, you need to configure the MCP settings:

For Cline (VS Code extension)

Edit the cline_mcp_settings.json file:

{
  "mcpServers": {
    "repomix": {
      "command": "npx",
      "args": [
        "-y",
        "repomix",
        "--mcp"
      ]
    }
  }
}

For Claude Desktop

Edit the claude_desktop_config.json file with similar configuration to Cline's config.

Benefits of Using Repomix as an MCP Server

Using Repomix as an MCP server offers several advantages:

1. Direct Integration: AI assistants can directly analyze your codebase without manual file preparation.
2. Efficient Workflow: Streamlines the process of code analysis by eliminating the need to manually generate and upload files.
3. Consistent Output: Ensures that the AI assistant receives the codebase in a consistent, optimized format.
4. Advanced Features: Leverages all of Repomix's features like code compression, token counting, and security checks.

Once configured, your AI assistant can directly use Repomix's capabilities to analyze codebases, making code analysis workflows more efficient.