JGC-473 follow-up: complete GetAIDescription() coverage for remaining umbrella commands

[Balasubramanyamkosuri]

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.go files 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.go
• docs/mcp/show/help.go
• docs/mcp/uninstall/help.go

Artifactory build-tool entry points (26)

• docs/artifactory/accesstokencreate/help.go
• docs/artifactory/cocoapodsconfig/help.go
• docs/artifactory/dotnet/help.go
• docs/artifactory/dotnetconfig/help.go
• docs/artifactory/gocommand/help.go
• docs/artifactory/goconfig/help.go
• docs/artifactory/gopublish/help.go
• docs/artifactory/gradle/help.go
• docs/artifactory/gradleconfig/help.go
• docs/artifactory/mvn/help.go
• docs/artifactory/mvnconfig/help.go
• docs/artifactory/npmci/help.go
• docs/artifactory/npmconfig/help.go
• docs/artifactory/npminstall/help.go
• docs/artifactory/npmpublish/help.go
• docs/artifactory/nuget/help.go
• docs/artifactory/nugetconfig/help.go
• docs/artifactory/nugetdepstree/help.go
• docs/artifactory/ocstartbuild/help.go
• docs/artifactory/pipconfig/help.go
• docs/artifactory/pipinstall/help.go
• docs/artifactory/podmanpull/help.go
• docs/artifactory/podmanpush/help.go
• docs/artifactory/swiftconfig/help.go
• docs/artifactory/yarn/help.go
• docs/artifactory/yarnconfig/help.go

Build tools (3)

• docs/buildtools/nix/help.go
• docs/buildtools/setup/help.go
• docs/buildtools/uvcommand/help.go

Suggested priority

1. MCP subcommands — agents configuring platform MCP integration hit these first
2. High-traffic build wrappers — rt mvn, rt gradle, rt npm publish, rt go publish, rt dotnet
3. Remaining config/install entry points — *-config variants, setup, nix, uvcommand

Requested work

• Add GetAIDescription() to all 32 help.go files listed above
• Ensure each description follows the established JGC-473 template (see docs/config/add/help.go as 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)

[Balasubramanyamkosuri]

Companion CI enforcement request: jfrog/jfrog-cli-core#1574

[ehl-jf]

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 (the mcp command landed after JGC-473), and jf 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:

• Hidden/deprecated rt-namespace duplicates (docs/artifactory/{mvnconfig, npmconfig, gopublish, accesstokencreate, cocoapods-config, swift-config, …}) — these are Hidden: true deprecated aliases. The canonical visible commands (jf mvn-config, jf npm-config, top-level jf atc, …) resolve to docs/buildtools/* / docs/general/*, which already have GetAIDescription.
• Dead-code stubs not wired into the umbrella (docs/artifactory/{gradle, dotnet, nuget, yarn, nugetdepstree, ocstartbuild, podmanpull, podmanpush}) — live copies are under docs/buildtools/* (covered) or in the jfrog-cli-artifactory plugin.
• Hidden pending GA — nix and setup are Hidden: 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: true and unwired doc stubs — otherwise it'll force AI text onto deprecated/dead commands and fail the legitimately-skipped files.