diff --git a/README.md b/README.md index fa8f097..0c46117 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,6 @@ VS Code opens, prompts you to install the plugin, and asks you to **Trust** the | Variable | Description | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `JFROG_URL` | Your JFrog platform URL, e.g. `https://mycompany.jfrog.io` (no trailing `/`). | | `JFROG_PLATFORM_URL` | Your JFrog platform host, **without** the scheme, e.g. `mycompany.jfrog.io`. Resolves the JFrog MCP server URL (`https://${env:JFROG_PLATFORM_URL}/mcp`). | | `JFROG_ACCESS_TOKEN` | Your JFrog access token | @@ -101,6 +100,29 @@ If you have never configured the JFrog CLI on this machine: ``` 3. Follow the interactive prompts to enter the same JFrog platform URL and access token. +Run **`/jfrog-init`** in Copilot Chat after install. **Reload the VS Code window** after MCP config changes (a new chat alone is not enough). Setting `JFROG_PLATFORM_URL` / `JFROG_ACCESS_TOKEN` does not repair a failed init walk — fix the reported step and re-run `/jfrog-init`. + +--- + +## Verify + +Verification is a required install step, not a troubleshooting fallback: + +1. The plugin appears in Copilot's installed plugins list. +2. **`/jfrog-init`** completes without blocking errors. +3. **Reload the VS Code window**, open a **new** Copilot chat, and enable the JFrog MCP tools in the tool picker. +4. `jf rt ping` — succeeds against your configured server. + +If a check fails, see [Recovery](#recovery). Fix the step `/jfrog-init` reports, re-run it, and reload the window. + +## Recovery + +| Symptom | Do this | Do **not** do this | +| --- | --- | --- | +| MCP missing after install | Run `/jfrog-init`, **reload the VS Code window**, open a **new** Copilot chat, enable JFrog MCP tools. | Assume a new chat without a window reload will pick up MCP changes. | +| `/jfrog-init` stopped at CLI/auth | Follow the skill prompt (`jf config add`, web login, or token path), then **re-run `/jfrog-init`**. | Skip init and only export env vars. | +| Env vars set after a failed init | Fix the reported step, re-run `/jfrog-init`, reload the window. | Expect `JFROG_PLATFORM_URL` alone to substitute the MCP host. | + --- ## Usage diff --git a/docs/package-resolution-user-guide.md b/docs/package-resolution-user-guide.md index 297800d..04ea939 100644 --- a/docs/package-resolution-user-guide.md +++ b/docs/package-resolution-user-guide.md @@ -101,12 +101,9 @@ To turn it off in the config file itself, set `"enabled": false`. If your file i This is a preview, and your feedback directly shapes what ships next. Please tell us about anything that felt confusing, broken, or surprising, good or bad. -File an issue on GitHub, in whichever plugin repo you use: +File an issue on GitHub: [github.com/jfrog/vscode-plugin/issues](https://github.com/jfrog/vscode-plugin/issues) -- Cursor: [github.com/jfrog/cursor-plugin/issues](https://github.com/jfrog/cursor-plugin/issues) -- Claude Code: [github.com/jfrog/claude-plugin/issues](https://github.com/jfrog/claude-plugin/issues) -- VS Code: [github.com/jfrog/vscode-plugin/issues](https://github.com/jfrog/vscode-plugin/issues) -- Email: plugins-feedback@jfrog.com +Email: plugins-feedback@jfrog.com ---