MCP Proxy Sidecar

🚀 MCP Proxy Sidecar

This is a fork of the JetBrains MCP Server created by @dortegau, with added WebSocket monitoring capabilities.

This project extends the functionality of the original MCP server by adding WebSocket support while maintaining compatibility with all features of the original implementation.

🚀 Quick Start

Installation

pnpm install mcp-proxy-sidecar

Startup

pnpm start

✨ Features

• Initial Fork: Based on the basic implementation of @jetbrains/mcp-proxy.
• WebSocket Support: Enables real-time monitoring of tool invocations.
• Clear Architecture: Preserves all features of the original implementation while adding new capabilities.

WebSocket Message Formats

interface WindowToFrontend {
    type: 'frontend-ready' | 'backend-ready' | 'proxy-connected';
}

interface ToBackendMessage {
    type: 'initialize' | 'get-configuration' | 'set-configuration';
    data?: unknown;
}

interface ConfigurationKey extends PropertyKey {}

Configuration Options

📦 Installation

pnpm install mcp-proxy-sidecar

💻 Usage Examples

Basic Usage

pnpm start

📚 Documentation

Architecture

graph LR
    A[MCP Client<br>e.g., Claude<br>Desktop Application]
    B[MCP Proxy<br>Sidecar<br>with WebSocket]
    C[JetBrains IDE]
    D[WebSocket Client<br>for Monitoring]
    
    A <--MCP Requests/Responses--> B
    B <--IDE Commands/Responses--> C
    B --WebSocket Notifications<br>Port 27042--> D

Architecture Diagram Explanation

• A: Represents the MCP client, such as the Claude desktop application.
• B: Represents the MCP proxy sidecar with WebSocket capabilities.
• C: Represents the JetBrains IDE.
• D: Represents the WebSocket client for monitoring.

🔧 Technical Details

Development Requirements

• Node.js: Requires Node.js 20.x
• Dependency Management: Uses pnpm (latest version)

Build Steps

1. Install dependencies:

   pnpm install --frozen-lockfile
   

2. Build the project:

   pnpm build
   

🤝 Contribution

1. Fork the Repository: First, fork this repository.
2. Create a Feature Branch: Create your feature branch (git checkout -b feature/amazing-feature).
3. Commit Changes: Commit your modifications (git commit -m 'Add some amazing features').
4. Push to the Branch: Push the branch to the remote repository (git push origin feature/amazing-feature).
5. Create a Pull Request: Submit a Pull Request.

🚀 Release

This package is published via npm. Use the following steps to release a new version:

1. Update the version number in package.json.
2. Create and push a new tag matching the version.
3. Create a GitHub release from the tag.
4. The workflow will automatically build and publish the package to npm.

📄 Changelog

1.0.0

• Initial fork from @jetbrains/mcp-proxy
• Added WebSocket support for real-time tool invocation monitoring
• Renamed the package for clarity
• Updated documentation and configuration examples

🙏 Acknowledgments

This project is a fork of the JetBrains MCP Proxy Server. All credits for the original implementation go to the JetBrains team.