Skip to content

Document VS Code resource attach and editor-assistance language model tools (Aspire 17.0) - #2192

Merged
David Pine (IEvangelist) merged 2 commits into
release/17.0from
copilot/document-vs-code-debugger-editor-tools
Nov 17, 2026
Merged

David Pine (IEvangelist) merged 2 commits into
release/17.0from
copilot/document-vs-code-debugger-editor-tools

Conversation

@karolz-ms

@karolz-ms Karol Zadora-Przylecki (karolz-ms) commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Important

Retarget this PR to release/17.0 before merging. Every page edited here exists only on release/17.0, so this branch merges that branch in. Against main, the diff also shows unrelated 17.0 content.

Aspire 17.0 adds two VS Code extension features: Attach debugger for running .NET and Go resources (microsoft/aspire#18602, extension v1.25.0) and six editor-assistance language model tools (microsoft/aspire#19414, v1.24.0). aspire.dev listed the tool names but didn't explain how to use either feature. The facts below come from the extension source and READMEs on microsoft/aspire release/17.0.

get-started/aspire-vscode-extension.mdx

  • New section "Attach a debugger to a running resource":
    • Prerequisites: ms-dotnettools.csharp for .NET; golang.go, Delve and 17.0 Go hosting for Go.
    • Steps, including the cancellable progress notification.
    • Behavior: attaches to the app process, not the dotnet run, dotnet watch or go run launcher. Never starts or restarts a resource. Reports when a debugger is already attached.
    • A missing debugger extension shows Open Extensions; install it and retry without restarting the AppHost.
    • Limitations: dotnet watch with arguments after --, WithDelveServer, and no detach tool ([VS Code] Add an agent tool to detach a resource debugger without stopping the application aspire#22154).
    • Note on Linux ptrace_scope and the macOS _developer group.
  • Language model tools:
    • Minimum extension versions per tool.
    • Fixed a claim: only the start and stop tools return knownAppHosts.
    • New "Language model tool reference": one collapsible <details> block per 17.0 tool with its inputs and outcomes. It also covers Hot Reload semantics, the latest launch failure kept per AppHost for 30 minutes, and dashboard and Output behavior.
  • Language coverage: a cross-link sentence instead of a new column. I couldn't verify whether attach works for the Azure Functions C# row.

integrations/frameworks/go/go-host.mdx

  • New subsection "Attach to a running Go resource (VS Code)":
    • Run Without Debugging and aspire start both use DCP-managed go run.
    • Debug info (symbols and DWARF) is kept by default.
    • Attach and WithDelveServer are mutually exclusive.
    • C#, TypeScript and Go samples for custom flags, for example:
builder.AddGoApp(
    name: "api",
    appDirectory: "./api",
    ldFlags: "-X main.version=1.2.3 -s=false -w=false",
    gcFlags: "all=-N -l");
  • The subsection warns that the -s -w flags in the existing "Configure build options" example strip the information source breakpoints need. That example is unchanged.

Other pages

  • app-host/hot-reload-and-watch.mdx: a paragraph on what aspire_hot_reload_status reports:
    • Enabled doesn't mean applicable; only .NET project resources this VS Code window launched under the debugger qualify.
    • AppHosts running outside the window don't qualify.
    • The fallback is to restart the resource, then rebuild and restart the AppHost.
  • reference/cli/commands/aspire-describe.mdx: the new project.launchCommand (run, watch, ide, direct, or null), project.configuration and project.targetFramework properties.
  • whats-new/aspire-17.mdx: a new "🧰 Visual Studio Code extension" section and an intro bullet.

Review notes

  • The Linux ptrace_scope note covers Go/Delve only. I couldn't confirm the .NET behavior, so the note doesn't mention it.
  • The Hot Reload text doesn't say whether a resource with an attached debugger counts as applicable; the sources don't settle it.

@karolz-ms

Copy link
Copy Markdown
Contributor Author

Copilot resolve the merge conflicts in this pull request

@karolz-ms

Copy link
Copy Markdown
Contributor Author

Copilot retarget this PR to release/17.0 branch NOW

Copilot AI commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Copilot resolve the merge conflicts in this pull request

Resolved in a615f44 by merging the latest main. The renderer keeps both the performance improvements and support-card details; the 17.0 documentation is unchanged. Validation passed: 89 unit tests, 3 image-endpoint smoke tests, lint, formatting, and CodeQL.

Copilot AI commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Copilot retarget this PR to release/17.0 branch NOW

I couldn’t change the base: this session has no PR-editing tool, and the browser is signed out of GitHub. #2192 still targets main. In the PR header, select Edit, change the base to release/17.0, then select Change base. No files or commits were changed.

… tools

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The restricted review environment prevented required documentation-rendering and interactive VS Code checks, leaving debugger behavior and Linux/macOS permission guidance dependent on human validation.

No open issues 🎉

What changed in this PR

Documents Aspire 17.0’s VS Code debugger attach workflow and editor-assistance language model tools, connecting the extension guide with Go debugging, Hot Reload, CLI reference, and release notes.

Changes:

  • Adds attach prerequisites, steps, limitations, and platform permission guidance.
  • Documents tool inputs, outcomes, minimum versions, and Hot Reload applicability.
  • Adds Go build-flag examples, project launch metadata, and release-note cross-links.
File Description
src/​frontend/​src/​content/​docs/​whats-new/​aspire-17.mdx Summarizes debugger attach and editor-assistance tools.
src/​frontend/​src/​content/​docs/​reference/​cli/​commands/​aspire-describe.mdx Documents project launch metadata and process ID behavior.
src/​frontend/​src/​content/​docs/​integrations/​frameworks/​go/​go-host.mdx Adds attach-later guidance and debug-friendly build flags.
src/​frontend/​src/​content/​docs/​get-started/​aspire-vscode-extension.mdx Adds the attach workflow and per-tool reference.
src/​frontend/​src/​content/​docs/​app-host/​hot-reload-and-watch.mdx Explains Hot Reload status applicability and fallback actions.

Review effort: Balanced

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Frontend HTML artifact ready

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

VS Code: Open PR #2192 artifacts

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

@IEvangelist
David Pine (IEvangelist) merged commit 2ce9b2b into release/17.0 Nov 17, 2026
18 checks passed
@IEvangelist
David Pine (IEvangelist) deleted the copilot/document-vs-code-debugger-editor-tools branch November 17, 2026 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document VS Code resource debugger attach and editor-assistance language model tools (Aspire 17.0)

5 participants