|
1 | | -# Perplexity MCP Extension |
| 1 | +<div align="center"> |
2 | 2 |
|
3 | | -Native VS Code extension packaging for the Perplexity MCP runtime. The extension embeds the MCP server, exposes a dashboard webview, and can generate `mcp.json` configs for Cursor, Windsurf, and Claude Desktop. |
| 3 | +<p align="center"> |
| 4 | + <picture> |
| 5 | + <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/perplexity.svg" height="120"> |
| 6 | + <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/perplexity.svg" height="120"> |
| 7 | + <img alt="Perplexity MCP" src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/Perplexity_Black.svg" height="120"> |
| 8 | + </picture> |
| 9 | +</p> |
| 10 | + |
| 11 | +# Perplexity MCP for VS Code |
| 12 | + |
| 13 | +**Use your Perplexity account (Free / Pro / Max) directly inside VS Code — no API key needed.** |
| 14 | + |
| 15 | +<p align="center"> |
| 16 | + <a href="https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode"><img src="https://vsmarketplacebadges.dev/version-short/Nskha.perplexity-vscode.svg?style=for-the-badge&label=VS%20Code&colorB=007ACC" alt="VS Code version" /></a> |
| 17 | + <a href="https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode"><img src="https://vsmarketplacebadges.dev/installs-short/Nskha.perplexity-vscode.svg?style=for-the-badge&label=Installs&colorB=1E8CBE" alt="VS Code installs" /></a> |
| 18 | + <a href="https://github.com/Automations-Project/VSCode-Perplexity-MCP/releases/latest"><img src="https://img.shields.io/github/v/release/Automations-Project/VSCode-Perplexity-MCP?style=for-the-badge&logo=github&logoColor=white&label=Latest%20Release&color=10B981" alt="Latest release" /></a> |
| 19 | + <a href="https://github.com/Automations-Project/VSCode-Perplexity-MCP/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Automations-Project/VSCode-Perplexity-MCP?style=for-the-badge&logo=opensourceinitiative&logoColor=white&label=License&color=22C55E" alt="License" /></a> |
| 20 | +</p> |
| 21 | + |
| 22 | +<br /> |
| 23 | + |
| 24 | +> **Not affiliated with Perplexity AI, Inc.** This is a community-maintained project. |
| 25 | +> |
| 26 | +> **Experimental** — Under active development. APIs and behavior may change without notice. |
| 27 | +
|
| 28 | +</div> |
| 29 | + |
| 30 | +--- |
| 31 | + |
| 32 | +## Install |
| 33 | + |
| 34 | +| IDE | Install | |
| 35 | +|:---:|:--------| |
| 36 | +| <img src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/vscode.svg" height="20" valign="middle" alt="VS Code" /> **Visual Studio Code** | [](https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode) | |
| 37 | +| <img src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/vscode.svg" height="20" valign="middle" alt="VS Code Insiders" /> **VS Code Insiders** | [](https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode) | |
| 38 | +| <img src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/cursor.svg" height="20" valign="middle" alt="Cursor" /> **Cursor** | [](https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode) | |
| 39 | +| <img src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/windsurf.svg" height="20" valign="middle" alt="Windsurf" /> **Windsurf** | [](https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode) | |
| 40 | +| <img src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/trae.svg" height="20" valign="middle" alt="Trae" /> **Trae** | [](https://marketplace.visualstudio.com/items?itemName=Nskha.perplexity-vscode) | |
| 41 | +| <img src="https://raw.githubusercontent.com/Automations-Project/VSCode-Perplexity-MCP/main/mcp-tool-icons/vscode.svg" height="20" valign="middle" alt="Open VSX" /> **Open VSX** (Gitpod · Theia · Coder) | [](https://open-vsx.org/extension/Nskha/perplexity-vscode) | |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## What is this? |
| 46 | + |
| 47 | +A VS Code extension that embeds the **Perplexity MCP runtime** directly in your editor. It drives a long-lived **patchright** Chromium session against your existing Perplexity account — so it uses your Free / Pro / Max plan instead of an API key. |
| 48 | + |
| 49 | +### Key features |
| 50 | + |
| 51 | +- **Zero API key** — authenticates via your browser session, uses your existing Perplexity plan. |
| 52 | +- **Embedded MCP server** — registered via `mcpServerDefinitionProviders`; agents (Copilot, Cursor, etc.) pick it up automatically. |
| 53 | +- **Webview dashboard** — login flows, profile management, session status, all inside VS Code. |
| 54 | +- **Auto-config for 15+ IDEs** — one click writes MCP configs and rulesets for Cursor, Windsurf, Claude Desktop, Cline, Amp, Codex CLI, and more. |
| 55 | +- **Daemon mode** — keep a long-lived HTTP MCP server running with Cloudflare or ngrok tunnels. |
| 56 | + |
| 57 | +--- |
| 58 | + |
| 59 | +## Getting started |
| 60 | + |
| 61 | +1. Install the extension from the Marketplace. |
| 62 | +2. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`) and run **`Perplexity: Login`**. |
| 63 | +3. A browser window opens — log in to your Perplexity account. |
| 64 | +4. Done. The MCP server is now available to any agent in VS Code. |
| 65 | + |
| 66 | +> **First run only:** Perplexity serves a Cloudflare Turnstile on the first login. The extension opens a headed browser so you can complete it. After that, sessions are cached and renewed automatically. |
| 67 | +
|
| 68 | +--- |
| 69 | + |
| 70 | +## Browser support |
| 71 | + |
| 72 | +The extension automates a real Chromium browser to survive Cloudflare. It probes in this order: |
| 73 | + |
| 74 | +| Priority | Browser | Notes | |
| 75 | +|:--------:|:--------|:------| |
| 76 | +| #1 | **Google Chrome** | Recommended — best Cloudflare compatibility | |
| 77 | +| #2 | **Microsoft Edge** | Works on all platforms | |
| 78 | +| #3 | **System Chromium** | Good for Linux / headless servers | |
| 79 | +| #4 | **Brave** | Auto-detected, no special flags | |
| 80 | +| #5 | **Bundled Chromium** | Fallback via `npx patchright install chromium` | |
| 81 | + |
| 82 | +Override detection with `PERPLEXITY_BROWSER_CHANNEL` or `PERPLEXITY_BROWSER_PATH`. |
| 83 | + |
| 84 | +--- |
| 85 | + |
| 86 | +## Auto-config: supported IDEs |
| 87 | + |
| 88 | +Run **`Perplexity: Configure IDEs`** from the Command Palette to auto-write MCP configs and rules for: |
| 89 | + |
| 90 | +| Client | Config written | |
| 91 | +|:-------|:--------------| |
| 92 | +| **Cursor** | `.cursor/rules/*.mdc`, `mcp.json` | |
| 93 | +| **Claude Desktop / Claude Code** | `claude_desktop_config.json`, `CLAUDE.md` | |
| 94 | +| **Windsurf** | `mcp_config.json`, `.windsurfrules` | |
| 95 | +| **Cline** | MCP settings, `.clinerules` | |
| 96 | +| **Amp** | `.github/instructions/*` | |
| 97 | +| **Codex CLI** | `mcp.json`, `AGENTS.md` | |
| 98 | +| …and 9 more | See [full IDE list](https://github.com/Automations-Project/VSCode-Perplexity-MCP#supported-ides--mcp-clients) | |
| 99 | + |
| 100 | +--- |
| 101 | + |
| 102 | +## Commands |
| 103 | + |
| 104 | +| Command | Description | |
| 105 | +|:--------|:-----------| |
| 106 | +| `Perplexity: Login` | Open login browser and authenticate | |
| 107 | +| `Perplexity: Logout` | Clear cached session | |
| 108 | +| `Perplexity: Configure IDEs` | Auto-write MCP configs for all supported IDEs | |
| 109 | +| `Perplexity: Open Dashboard` | Open the webview dashboard | |
| 110 | +| `Perplexity: Restart Server` | Restart the embedded MCP daemon | |
| 111 | + |
| 112 | +--- |
| 113 | + |
| 114 | +## Links |
| 115 | + |
| 116 | +- [GitHub Repository](https://github.com/Automations-Project/VSCode-Perplexity-MCP) |
| 117 | +- [Changelog](https://github.com/Automations-Project/VSCode-Perplexity-MCP/blob/main/CHANGELOG.md) |
| 118 | +- [Report a Bug](https://github.com/Automations-Project/VSCode-Perplexity-MCP/issues/new?template=bug-report.yml) |
| 119 | +- [npm package (standalone MCP server)](https://www.npmjs.com/package/perplexity-user-mcp) |
| 120 | + |
| 121 | +--- |
| 122 | + |
| 123 | +**MIT License** · Not affiliated with Perplexity AI, Inc. |
0 commit comments