Skip to content
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Before installing, make sure you have:
- **Node.js** (≥ 18) — with `npx` on your `PATH`.
- **Skill runtime requirements** — `jf` CLI, `jq`, and `curl` on `PATH`, plus a configured JFrog instance. For the minimum versions, see the upstream skills [`Requirements`](https://github.com/jfrog/jfrog-skills/blob/v0.11.0/README.md#requirements). Configure the CLI with `jf config add` — see [Authentication](#authentication).
- **JFrog Platform access** (optional) — If you want to use the Agent Guard feature, your JFrog subscription needs to include the AI Catalog entitlement. Contact your JFrog account team if you're unsure whether it's enabled.
- **JFrog CLI ≥ 2.105.0** (optional) — If you want the Agent Guard to auto-resolve credentials/server ID from the JFrog CLI instead of `JFROG_PLATFORM_URL`/`JFROG_ACCESS_TOKEN` env vars. Older CLIs don't support the `--format` flag used by `jf config show`/`jf config export` for this.
- **JFrog CLI ≥ 2.105.0** (optional) — If you want the Agent Guard to auto-resolve the credentials/server ID from the JFrog CLI configuration. Older CLIs don't support the `--format` flag used by `jf config show`/`jf config export` for this.
- **JFrog project** (optional) — If you want to use the Agent Guard feature.

---
Expand All @@ -46,6 +46,29 @@ Use either the marketplace link from the [Configure Cursor](https://docs.jfrog.c
3. Search for **JFrog** and open the **JFrog** plugin.
4. Choose **Add to Cursor**, then **Add Plugin**.

Run **`/jfrog-init`** after install, **restart Cursor** if MCP config changed, then complete [Verify](#verify).

---

## Verify

Verification is a required install step, not a troubleshooting fallback:

1. **Cursor Settings → Plugins** — the JFrog plugin is installed.
2. **`/jfrog-init`** — the readiness walk completes without blocking errors.
3. `jf rt ping` — succeeds against your configured server.

If a check fails, see [Recovery](#recovery). `JFROG_PLATFORM_URL` is for MCP
placeholder resolution only. Setting it does not repair a failed `/jfrog-init`.

## Recovery

| Symptom | Do this | Do **not** do this |
| --- | --- | --- |
| MCP missing after install | Run `/jfrog-init`, complete OAuth if prompted, **restart Cursor**, re-check MCP tools. | Assume `JFROG_PLATFORM_URL` alone will register MCP. |
| `/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. |
| Placeholder URL still in plugin MCP config | Fix `jf config` for the intended server, re-run `/jfrog-init`. | Reinstall the plugin when the detector says auth/URL resolution failed. |

---

## Authentication
Expand Down
7 changes: 2 additions & 5 deletions docs/package-resolution-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/cursor-plugin/issues](https://github.com/jfrog/cursor-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

---

Expand Down
2 changes: 1 addition & 1 deletion plugins/jfrog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ JFrog Platform integration for Cursor — artifact management, security scanning
- Toggle the **MCP Server** option ON and save.
3. Set the `JFROG_PLATFORM_URL` environment variable to your JFrog instance (e.g., `mycompany.jfrog.io`).
4. **JFrog CLI** (`jf`) is used by the skills for authentication and REST/GraphQL API operations. If missing, the agent will attempt to install it. You can also install manually via `brew install jfrog-cli` or the [official install script](https://jfrog.com/help/r/jfrog-cli/install-the-jfrog-cli).
5. **JFrog CLI ≥ 2.105.0** (optional) — required if you want the Agent Guard to auto-resolve credentials/server ID from the JFrog CLI instead of `JFROG_URL`/`JFROG_ACCESS_TOKEN` env vars. Older CLIs don't support the `--format` flag used by `jf config show`/`jf config export` for this.
5. **JFrog CLI ≥ 2.105.0** (optional) — required if you want the Agent Guard to auto-resolve the credentials/server ID from the JFrog CLI configuration. Older CLIs don't support the `--format` flag used by `jf config show`/`jf config export` for this.

CLI authentication options: run `jf login` for browser-based setup, or set the `JFROG_ACCESS_TOKEN` environment variable. MCP-based workflows authenticate via **OAuth** and require no additional configuration.

Expand Down
Loading