Ax-1425-update vscode marketplace metadata readme#11
Conversation
Replace the placeholder README with full plugin documentation covering prerequisites, installation options, authentication, usage, and troubleshooting for the JFrog MCP Gateway integration. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
| # vscode-plugin No newline at end of file | ||
| # JFrog MCP Integration for VS Code | ||
|
|
||
| JFrog integration for [Visual Studio Code](https://code.visualstudio.com/) and **GitHub Copilot Chat**: connect your Copilot agent to the [JFrog Agent Guard](https://jfrog.com) for policy-governed MCP access, with all MCP servers installed exclusively through the **JFrog MCP Gateway**. |
There was a problem hiding this comment.
I don't think that JFrog Agent Guard should point to jfrog,com. Maybe to a specific page there
There was a problem hiding this comment.
There won't be MCP Gateway soon. We shouldn't write it
|
|
||
| Before installing, make sure you have: | ||
|
|
||
| - **JFrog Platform access** — An active account with the AI Catalog enabled. |
There was a problem hiding this comment.
I think that we should talk about entitlements here
There was a problem hiding this comment.
you mean something like:
Your JFrog subscription must include the AI Catalog entitlement. Contact your JFrog account team if you're unsure whether it's enabled.
before "An active account with the AI Catalog enabled." ?
| - **JFrog project** — At least one MCP server allowed for your project. | ||
| - **JFrog host URL and access token** — Your JFrog platform URL and a valid access token. | ||
| - **VS Code** — With the **GitHub Copilot Chat** extension installed and signed in. | ||
| - **GitHub Copilot editor preview features enabled** — In your GitHub organization settings, navigate to **Settings → Copilot → Policies → Editor preview features** and set it to **Enabled**. Also set the environment variable `JF_MCP_GATEWAY_FORCE_ENABLE=true`. |
There was a problem hiding this comment.
Not sure we need the feature enabled
There was a problem hiding this comment.
you right. it's a mistake
| - **JFrog host URL and access token** — Your JFrog platform URL and a valid access token. | ||
| - **VS Code** — With the **GitHub Copilot Chat** extension installed and signed in. | ||
| - **GitHub Copilot editor preview features enabled** — In your GitHub organization settings, navigate to **Settings → Copilot → Policies → Editor preview features** and set it to **Enabled**. Also set the environment variable `JF_MCP_GATEWAY_FORCE_ENABLE=true`. | ||
| - **Node.js** (≥ 18) — with `npx` on your `PATH` — required so the `mcp-gateway` can be fetched on demand. |
There was a problem hiding this comment.
Are we sure we need starting from version >= 18?
There was a problem hiding this comment.
i was not sure about it, an i mention it on the pr.
According to the mcp-proxy readme, it requires - Node.js 14 or later.
|
|
||
| ### Option 1 — Magic link (recommended) | ||
|
|
||
| From the [JFrog Platform → AI/ML → Registry → Your Project → MCP Servers](https://jfrog.com), click **Install MCP**, choose **VS Code** as your IDE, then click **Install via magic link**. Alternatively, open this link in any browser: |
There was a problem hiding this comment.
Nice, let's have a better UX and provide a screenshot
There was a problem hiding this comment.
the ux now is WOW
| ### Option A — JFrog CLI (`jf config add`) | ||
|
|
||
| If you already have the JFrog CLI installed and configured, the plugin uses your existing authentication. To configure it: | ||
|
|
||
| 1. Open your terminal. | ||
| 2. Run: | ||
| ```bash | ||
| jf config add | ||
| ``` | ||
| 3. Follow the interactive prompts to enter your JFrog Platform URL and access token. | ||
| 4. Restart your IDE / terminal to apply the changes. |
There was a problem hiding this comment.
I think that this is relevant only if the user didn't do it in the past
| | ----------------------- | ---------------------------------------------------------- | | ||
| | `JFROG_PLATFORM_URL` | Your JFrog platform URL, e.g. `https://mycompany.jfrog.io` | | ||
| | `JFROG_ACCESS_TOKEN` | Your JFrog access token | | ||
| | `JF_PROJECT` | Your project key | |
There was a problem hiding this comment.
This envar is not necessary for authentication
There was a problem hiding this comment.
you are only talking about JF_PROJECT ?
| **macOS / Linux (zsh or bash):** | ||
|
|
||
| Add the variables to your shell profile so they load automatically every time a terminal (or VS Code) starts. | ||
|
|
||
| 1. Open your profile (`~/.zshrc` on macOS or `~/.bashrc` on Linux): | ||
| ```bash | ||
| nano ~/.zshrc | ||
| ``` | ||
| 2. Add the following lines at the bottom of the file: | ||
| ```bash | ||
| export JFROG_PLATFORM_URL="<your-platform-url>" | ||
| export JF_PROJECT="<your-project-key>" | ||
| export JFROG_ACCESS_TOKEN="<your-access-token>" | ||
| ``` | ||
| 3. Save and exit (`Ctrl+O`, `Enter`, then `Ctrl+X`). | ||
| 4. Apply the changes: | ||
| ```bash | ||
| source ~/.zshrc | ||
| ``` | ||
|
|
||
| **Windows (PowerShell):** | ||
|
|
||
| Use `setx` to save the variables permanently to your user account settings. | ||
|
|
||
| ```powershell | ||
| setx JFROG_PLATFORM_URL "<your-platform-url>" | ||
| setx JF_PROJECT "<your-project-key>" | ||
| setx JFROG_ACCESS_TOKEN "<your-access-token>" | ||
| ``` |
There was a problem hiding this comment.
I wouldn't explain HOW to set the environment variables
|
|
||
| ### How secrets are handled | ||
|
|
||
| When an MCP server requires sensitive configuration (marked as `isSecret` in the server's metadata), the agent cannot set the value directly. Instead, it returns a CLI command for you to copy and run in your terminal. Secrets such as API keys, tokens, and connection strings are never exposed in the agent chat history. |
There was a problem hiding this comment.
| When an MCP server requires sensitive configuration (marked as `isSecret` in the server's metadata), the agent cannot set the value directly. Instead, it returns a CLI command for you to copy and run in your terminal. Secrets such as API keys, tokens, and connection strings are never exposed in the agent chat history. | |
| When an MCP server requires a sensitive configuration, the agent cannot set the value directly. Instead, it returns a CLI command for you to copy and run in your terminal. Secrets such as API keys, tokens, and connection strings are never exposed in the agent chat history. |
Reflow the intro into three tight lines using <br> breaks and wrap the Option 3 settings.json snippet in braces so it parses standalone. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…nstructions and troubleshooting details
Name
Ax-1425-update vscode marketplace metadata readme
Description
update readme file
comments
please check the versions i added:
Claude Code CLI(≥ 1.0)
Node.js (≥ 18)
Frog CLI (≥ 2.x, optional)