[docs] Document Show tunnel URLs command for Dev Tunnels integration

[aspire-repo-bot]

Documents changes from microsoft/aspire#16842

@maddymontaquila

Targeting release/13.5 — the latest release branch on microsoft/aspire.dev — because release/13.6 (from the source PR milestone 13.6) does not exist there.

Why

microsoft/aspire#16842 adds a highlighted Show tunnel URLs command to dev tunnel port resources, and publishes the tunnel, inspect, and local endpoint URLs as highlighted resource properties in the dashboard property pane. The existing Dev Tunnels integration doc didn't mention this discoverability feature.

What changed

• src/frontend/src/content/docs/integrations/devtools/dev-tunnels.mdx: added a new Show tunnel URLs section (between "Service discovery integration" and its predecessor) describing:
  • The highlighted properties shown in the dashboard property pane (Tunnel URL, Inspect URL, Local endpoint URL)
  • The Show tunnel URLs dashboard command and the message box it opens
  • A note that the command is only enabled once the tunnel is running and its public URL is allocated

No new pages were created; only the existing dev-tunnels.mdx page was updated in place.

Generated by PR Documentation Check for #16842 · auto · 51.5 AIC · ⌖ 6.39 AIC · ⊞ 19.6K · ◷

[aspire-repo-bot]

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1492. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

This comment updates automatically when a new frontend build artifact is uploaded.

[Copilot]

Pull request overview

Updates the Dev Tunnels integration documentation to cover the new dashboard discoverability features for tunnel URLs (highlighted properties + a Show tunnel URLs command) introduced in microsoft/aspire#16842.

Changes:

• Added a new Show tunnel URLs section describing the highlighted Tunnel/Inspect/Local endpoint URL properties in the dashboard.
• Documented the Show tunnel URLs dashboard command and its enabled-only-when-running behavior.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[David Pine (IEvangelist)]

Automated docs-accuracy review — Phase A (claims) + Phase B (doc-tester)

Phase A source of truth: microsoft/aspire @ release/13.5, SHA 8ab6999850d96e0023670799edbd4bdc245ad63c (authoritative remote tip; matches this PR's base branch).
Reviewed head SHA: 90f0d1e38028a08857cb064929f55bb78e798512.

Phase A — claims: 4 non-narrative claims extracted → 0 verified, 0 verified-with-nuance, 4 unverifiable, 0 contradicted.
Phase B — doc-tester: 1 page exercised (/integrations/devtools/dev-tunnels/, anchor #show-tunnel-urls) → 0 critical, 0 warnings, 0 knowledge gaps.

Verdict: COMMENT.

⚠️ Key finding — the documented feature isn't on the branch this PR targets

This PR targets release/13.5, so microsoft/aspire's release/13.5 branch (8ab6999) is the source of truth. The entire "Show tunnel URLs" feature — the highlighted command, the message box, and the highlighted tunnel/inspect/local URL properties — is not present on release/13.5. On that branch, src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs registers no .WithCommand(...) on the dev tunnel port resource and marks no properties as highlighted; it only surfaces the tunnel and inspect URLs via .WithUrls(...) (the inspect URL uses DisplayLocation = UrlDisplayLocation.DetailsOnly).

The feature does exist on microsoft/aspire main (0be40cb992247cbe8ed7bb6d12069947e8338f14), where the doc's description is accurate. So this reads as a branch-targeting / not-yet-backported issue rather than a factual error in the prose: the content correctly documents main, but it's being added to a release branch that doesn't ship the feature yet.

Recommendation: confirm the show-tunnel-urls command has been (or will be) backported to microsoft/aspire release/13.5 before merging this into the release/13.5 docs, or retarget the PR to the docs branch that corresponds to the release carrying this feature. All four claims below are marked unverifiable strictly against the target branch — none are contradicted by the source (the feature is simply absent there).

---

Phase A — Claim verification

All four non-narrative claims share the single root cause above (feature absent on release/13.5). Evidence that it is present on main (0be40cb, context only — not the source of truth for this PR) is included per claim.

• C1 — "the dashboard publishes the public tunnel URL, the inspect URL, and the local endpoint URL as highlighted properties on the tunnel port resource's property pane." unverifiable on release/13.5 (no highlighted properties; URLs surfaced via WithUrls). On main: GetUrlProperties(...) builds TunnelUrl/InspectUrl/LocalEndpointUrl ResourcePropertySnapshots each with IsHighlighted = true.
• C2 — "select the highlighted Show tunnel URLs command from the port resource's command menu." unverifiable on release/13.5 (no WithCommand). On main: DevTunnelResourceBuilderExtensions.cs .WithCommand(ShowTunnelUrlsCommandName /* "show-tunnel-urls" */, …, new CommandOptions { IsHighlighted = true, … }).
• C3 — "This opens a message box listing: Tunnel URL, Inspect URL, Local endpoint URL." unverifiable on release/13.5. On main: ShowTunnelUrlsAsync(...) calls interactionService.PromptMessageBoxAsync(...), with the three labeled entries from GetUrlProperties.
• C4 — "The Show tunnel URLs command is only enabled once the tunnel port is running and its public URL has been allocated." unverifiable on release/13.5. On main: the command's UpdateState returns Enabled only when interactionService.IsAvailable && State == Running && portResource.LastKnownStatus?.PortUri is not null, else Disabled.

The Inspect URL external link (learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests) is outside microsoft/aspire and out of scope for source verification; Phase B confirmed it renders as a link with a valid href.

---

Phase B — Doc-tester results

Report reproduced verbatim from the doc-tester skill run (blind to source; navigation via Playwright; served locally with pnpm dev). Note: Phase B tests only whether the added prose renders and reads well — it cannot detect the branch-mismatch above, which is a Phase A (source-of-truth) finding.

Documentation Test Report

Focus Area: PR #1492 Dev Tunnels "Show tunnel URLs" subsection
Date: 2026-08-14
Tester: doc-tester agent
Served Base URL: http://localhost:4321/
Served Head SHA: 90f0d1e38028a08857cb064929f55bb78e798512

Routes Exercised:

• http://localhost:4321/integrations/devtools/dev-tunnels/
• http://localhost:4321/integrations/devtools/dev-tunnels/#show-tunnel-urls

Screenshots:

• pr1492-show-tunnel-urls.png

Summary

Category	Passed	Failed	Warnings
Content Accuracy	4	0	0
Code Examples	0	0	0
CLI Commands	0	0	0
Links	2	0	0

Critical Issues

None.

Warnings

None.

Passed Checks

• The Dev Tunnels page loaded successfully.
• The "Show tunnel URLs" subsection appears in the "On this page" navigation.
• Clicking "Show tunnel URLs" navigated to #show-tunnel-urls.
• The subsection rendered in the expected position before "Service discovery integration."
• The intro paragraph clearly explains the highlighted dashboard properties.
• The highlighted Show tunnel URLs command text rendered clearly.
• The bulleted list rendered with bold labels for Tunnel URL, Inspect URL, and Local endpoint URL.
• The em dash rendered correctly as —.
• The "dev tunnels inspect" external link rendered with href https://learn.microsoft.com/azure/developer/dev-tunnels/inspect-tunneling-http-requests.
• The Note callout rendered correctly and explains the command enablement condition.
• No broken anchor, duplicate content, or formatting issue was observed in the tested section.

Recommendations

1. Priority fixes: None.
2. Documentation gaps: None found in the tested section.
3. Product issues: None discovered from blind documentation testing.

Knowledge Gaps

None.

---

Automated review: Phase A verifies claims against microsoft/aspire source at the release-branch SHA; Phase B validates the rendered docs as a new user via the doc-tester skill. This is a non-blocking COMMENT; the key item is confirming the feature ships in the targeted release branch.

[David Pine (IEvangelist)]

Source-of-truth check (Phase A): this feature isn't on release/13.5, the branch this PR targets.

Verified against microsoft/aspire release/13.5 @ 8ab6999850d96e0023670799edbd4bdc245ad63c. On that branch, src/Aspire.Hosting.DevTunnels/DevTunnelResourceBuilderExtensions.cs registers no .WithCommand(...) on the dev tunnel port resource and marks no properties as highlighted — the port only exposes the tunnel/inspect URLs via .WithUrls(...) (inspect is DisplayLocation = UrlDisplayLocation.DetailsOnly). So, against the branch this PR targets, all of the following are unverifiable:

• the "highlighted properties" on the property pane (this paragraph),
• the highlighted Show tunnel URLs command,
• the message box listing Tunnel URL / Inspect URL / Local endpoint URL,
• the "only enabled once the tunnel port is running and its public URL has been allocated" note.

The feature does exist on microsoft/aspire main (0be40cb992247cbe8ed7bb6d12069947e8338f14) — .WithCommand("show-tunnel-urls", …, IsHighlighted = true), ShowTunnelUrlsAsync → PromptMessageBoxAsync, and GetUrlProperties(...) with IsHighlighted = true on the three URL properties — where this description is accurate.

Please confirm show-tunnel-urls has been (or will be) backported to release/13.5 before merging here, or retarget this to the docs branch matching the release that carries the feature. (Not a prose error — the content correctly documents main.)

[Maddy Montaquila (maddymontaquila)]

This feature is not for 13.5 it's for 13.6, will retarget the PR. Thanks!