MCP Proxy Sidecar

🚀 MCP 代理側邊車

MCP 代理側邊車是由 @dortegau 創建的 JetBrains MCP Server 的一個分支，它擴展了原始 MCP 服務器的功能，添加了 WebSocket 監控功能，同時保持對原始實現所有功能的兼容性，可用於即時監控工具調用情況。

🚀 快速開始

安裝

pnpm install mcp-proxy-sidecar

啟動

pnpm start

✨ 主要特性

• 初始 fork：基於 @jetbrains/mcp-proxy 的基礎實現。
• WebSocket 支持：實現了即時工具調用監控功能。
• 架構清晰：保持了原始實現的所有功能，同時擴展了新的特性。

📚 詳細文檔

架構

graph LR
    A[MCP 客戶端<br>例如 Claude<br>桌面應用程序]
    B[MCP 代理<br>側邊車<br>帶 WebSocket]
    C[JetBrains IDE]
    D[WebSocket 客戶端<br>監控]
    
    A <--MCP 請求/響應--> B
    B <--IDE 命令/響應--> C
    B --WebSocket 通知<br>端口 27042--> D

架構圖說明

• A：表示 MCP 客戶端，例如 Claude 桌面應用程序。
• B：表示 MCP 代理側邊車，具備 WebSocket 功能。
• C：表示 JetBrains IDE。
• D：表示用於監控的 WebSocket 客戶端。

WebSocket 消息格式

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

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

interface ConfigurationKey extends PropertyKey {}

配置選項

💻 使用示例

基礎用法

# 安裝依賴
pnpm install mcp-proxy-sidecar
# 啟動項目
pnpm start

🔧 技術細節

開發要求

• Node.js：需要 Node.js 20.x
• 依賴管理：使用 pnpm (最新版本)

建設步驟

1. 安裝依賴:

   pnpm install --frozen-lockfile
   

2. 構建項目:

   pnpm build
   

🤝 貢獻

1. fork 倉庫：首先 fork 這個倉庫。
2. 創建功能分支：創建你的功能分支（git checkout -b feature/amazing-feature）。
3. 提交更改：提交你的修改（git commit -m '添加一些神奇的功能'）。
4. 推送到分支：推送分支到遠程倉庫（git push origin feature/amazing-feature）。
5. 創建 Pull Request：提交一個 Pull Request。

🚀 發佈

此包通過 npm 發佈，使用以下步驟發佈新版本：

1. 更新 package.json 中的版本號。
2. 創建並推送與版本匹配的新標籤。
3. 從標籤創建 GitHub 發佈。
4. 工作流將自動構建並將包發佈到 npm。

📝 變更日誌

1.0.0

• 初始 fork 自 @jetbrains/mcp-proxy
• 添加 WebSocket 支持，實現即時工具調用監控
• 重命名包以便更清晰
• 更新文檔和配置示例

🙏 致謝

此項目是 JetBrains MCP Proxy Server 的一個分支。所有原始實現的功勞歸 JetBrains 團隊所有。

📄 許可證

本項目採用 Apache 2.0 許可證。