microsoft / microsoft/vscode-docs

Document remote Agent Host connection diagnostics

Open
#10,310 0 comments 0 reactions 1 assignee View on GitHub

@ntrogh is already working on this.

Since Sep 17, 2026.

doc-enhancement
Dominant language
Markdown
Stars
6.6k
Forks
5.8k
Avg merge
11h 43m
Merged PRs (30d)
123

Description

Product change

The Agents UI can show a connection diagnostics report for remote hosts, including discovery results, host state, recent activity, and client information. Users can copy, download, refresh, or close the report. The web client also keeps automatic connection attempts visibly in the Connecting state and exposes connection information from the mobile host picker.

Why the docs need an update

docs/agents/run/remote-agent-sessions.md only documents Online and Offline host states and automatic reconnection. It does not explain the diagnostics workflow, pending connection state, or mobile entry point.

Suggested documentation

  • docs/agents/run/remote-agent-sessions.md: Add connection-state troubleshooting and the Show Connection Diagnostics or Connection Information workflows, including what refresh does and does not do.

Acceptance criteria

  • Remote-session documentation explains how to open and export connection diagnostics.
  • The Connecting state and mobile access are covered.
  • The documentation does not imply that refreshing diagnostics reconnects a host.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.