VSCode in HA is primarily useful for editing config files and with all the latest pushes towards config in the UI it’s not as useful as it used to be. That said, it does integrate with HA to provide completion for entities and some basic yaml validation.
I also use it to work on ESPhome configs as well as some simple file management. I never got SSH working correctly on the HA VM and VSCode has been a convenient workaround.