Repository navigation
JGC-473 follow-up: complete GetAIDescription() coverage for remaining umbrella commands #3544
Description
Summary
JGC-473 shipped AI-agent-oriented help text (GetAIDescription()) for most umbrella commands. Coverage is still partial: when JFROG_CLI_AI_HELP=true or automatic agent detection is active, 32 visible commands fall back to the short human GetDescription() one-liner instead of the structured agent guide (When to use / Prerequisites / Common patterns / Gotchas / Related).
This creates an inconsistent agent experience: commands like jf rt upload and jf c add return rich task-oriented help, while adjacent commands in the same workflow do not.
Context
- Foundation: jfrog-cli-core#1563 (
ResolveDescription,AIHelpEnabled) - Umbrella delivery: #3503 (85
help.gofiles backfilled; 28 hidden/deprecated stubs intentionally skipped) - Embedded plugin repos (artifactory, security, evidence, platform-services, application) received separate JGC-473 PRs and are out of scope for this umbrella gap list
Commands missing GetAIDescription() (32)
MCP (3)
docs/mcp/install/help.godocs/mcp/show/help.godocs/mcp/uninstall/help.go
Artifactory build-tool entry points (26)
docs/artifactory/accesstokencreate/help.godocs/artifactory/cocoapodsconfig/help.godocs/artifactory/dotnet/help.godocs/artifactory/dotnetconfig/help.godocs/artifactory/gocommand/help.godocs/artifactory/goconfig/help.godocs/artifactory/gopublish/help.godocs/artifactory/gradle/help.godocs/artifactory/gradleconfig/help.godocs/artifactory/mvn/help.godocs/artifactory/mvnconfig/help.godocs/artifactory/npmci/help.godocs/artifactory/npmconfig/help.godocs/artifactory/npminstall/help.godocs/artifactory/npmpublish/help.godocs/artifactory/nuget/help.godocs/artifactory/nugetconfig/help.godocs/artifactory/nugetdepstree/help.godocs/artifactory/ocstartbuild/help.godocs/artifactory/pipconfig/help.godocs/artifactory/pipinstall/help.godocs/artifactory/podmanpull/help.godocs/artifactory/podmanpush/help.godocs/artifactory/swiftconfig/help.godocs/artifactory/yarn/help.godocs/artifactory/yarnconfig/help.go
Build tools (3)
docs/buildtools/nix/help.godocs/buildtools/setup/help.godocs/buildtools/uvcommand/help.go
Suggested priority
- MCP subcommands — agents configuring platform MCP integration hit these first
- High-traffic build wrappers —
rt mvn,rt gradle,rt npm publish,rt go publish,rt dotnet - Remaining config/install entry points —
*-configvariants,setup,nix,uvcommand
Requested work
- Add
GetAIDescription()to all 32help.gofiles listed above - Ensure each description follows the established JGC-473 template (see
docs/config/add/help.goas reference) - Wire through existing
corecommon.ResolveDescription()call sites (no new plumbing expected) - Validate examples against real flags (see #3503 follow-up commit that corrected invented flags in AI examples)
Tech writing offer
Technical writing can supply draft GetAIDescription() text for priority commands to reduce eng load — please comment if a shared template or batch PR approach is preferred.
Related follow-up
CI enforcement to block new commands without GetAIDescription() is tracked separately in jfrog-cli-core (see linked issue once filed).
Reported by @Balasubramanyamkosuri (JFrog Technical Writing)
Activity
Balasubramanyamkosuri commentedon Jun 15, 2026
Companion CI enforcement request: jfrog/jfrog-cli-core#1574
ehl-jf commentedon Jun 15, 2026
Thanks for the thorough list, @Balasubramanyamkosuri. I went through all 32 against the command wiring — flagging where the count is misleading so we scope the right work.
The genuinely user-visible gaps are 4, not 32:
jf mcp install,jf mcp show,jf mcp uninstall(themcpcommand landed after JGC-473), andjf uv(now GA). These do fall back to the short description in AI mode. Addressed in JGC-504 (PR incoming).The remaining ~28 are not user-visible, so backfilling them has no agent-facing effect:
rt-namespace duplicates (docs/artifactory/{mvnconfig, npmconfig, gopublish, accesstokencreate, cocoapods-config, swift-config, …}) — these areHidden: truedeprecated aliases. The canonical visible commands (jf mvn-config,jf npm-config, top-leveljf atc, …) resolve todocs/buildtools/*/docs/general/*, which already haveGetAIDescription.docs/artifactory/{gradle, dotnet, nuget, yarn, nugetdepstree, ocstartbuild, podmanpull, podmanpush}) — live copies are underdocs/buildtools/*(covered) or in thejfrog-cli-artifactoryplugin.nixandsetupareHidden: true; best done as part of their GA PRs.This matches JGC-473's deliberate policy of skipping hidden/deprecated commands. Suggest rescoping this ticket to the 4 visible commands (done in JGC-504) and closing the rest as out-of-scope.
On the CI-enforcement companion (core#1574): it should exclude
Hidden: trueand unwired doc stubs — otherwise it'll force AI text onto deprecated/dead commands and fail the legitimately-skipped files.Add AI-agent help text to mcp and uv commands (#3545)