Repository navigation
Closed
Description
Summary
Aspire 17.0 (VS Code extension 1.24.0+/1.25.0+) adds two VS Code features. aspire.dev lists their tool names (via #2150 on release/17.0) but doesn't document how to use them:
- Add VS Code resource debugging for .NET and Go aspire#18602 adds Attach debugger for running .NET and Go resources, in the Aspire view and through the
aspire_resource_debug(#aspireDebugResource) language model tool. Shipped in extension v1.25.0. - Add Aspire editor assistance language model tools aspire#19414 adds six editor-assistance language model tools and hardens
aspire_apphost_startandaspire_apphost_stop. The six new tools areaspire_debug_session_status,aspire_explain_launch_failure,aspire_open_dashboard,aspire_open_output,aspire_list_debug_sessions, andaspire_hot_reload_status. Shipped in extension v1.24.0.
What exists today
release/17.0,get-started/aspire-vscode-extension.mdx, section "Let coding agents use Aspire language model tools": a 9-tool table, the start tool's inputs, the confirmation list, and a one-line privacy statement.main(live site): onlyaspire_apphost_startandaspire_apphost_stop.whats-new/aspire-17.mdx: no LM-tool coverage. Open Fill gaps in What's new in Aspire 17.0 #2177 adds one bullet about attach.
Gaps
- Attach debugger tree action. The Aspire view's right-click list doesn't mention Attach debugger for running .NET project and Go resources. Its progress, cancellation, and "a debugger is already attached" behavior aren't documented either.
- Prerequisites and retry.
- .NET needs the C# extension (
ms-dotnettools.csharp). - Go needs the Go extension (
golang.go) and Delve. - When the debugger extension is missing, a notification opens Extensions. After installing or enabling it, retry. The AppHost doesn't need to restart.
- .NET needs the C# extension (
- Works without a debug session. Attach works for resources started with Run Without Debugging or
aspire start. It targets the app process, not thedotnet run,dotnet watch, orgo runlauncher. It doesn't restart the resource, and the tool never starts or restarts one. - Limitations.
dotnet watchresources with arguments after the first--can't be attached.- Resource-debug confirmation is bound to the resolved AppHost.
- There's no detach tool ([VS Code] Add an agent tool to detach a resource debugger without stopping the application aspire#22154).
- Linux permissions. Under Ubuntu's default
kernel.yama.ptrace_scope=1, Delve can't attach to a DCP-launched Go resource. Document the requirement and the trade-off. The product's CI setsptrace_scope=0. For macOS: in validation on macOS 27 (arm64), Delve attach to a DCP-launched Go resource succeeded withDevToolsSecuritydisabled for an account in the_developergroup; accounts outside that group may get a Developer Tools Access authorization prompt. Consider a short note. - Go integration.
integrations/frameworks/go/go-host.mdx→ "Debug Go apps" describes only F5 debugging. Add attach-later guidance:- Run Without Debugging uses DCP-managed
go run. - Symbols and DWARF are retained by default, including under
aspire start. - Custom
ldFlagsmust keep-s=false -w=false. - Use
gcFlags: "all=-N -l"for predictable stepping. - Attach is mutually exclusive with
WithDelveServer.
Source:src/Aspire.Hosting.Go/README.md, "Debugging".
- Run Without Debugging uses DCP-managed
- Tool details.
- Inputs:
aspire_resource_debugtakesappHostPath,resourceName, andstrategy(autoorattach).- status takes
appHostPathand an optionalresourceName. - Hot Reload takes an optional
resourceNameandappHostPath, with its disambiguation rules.
- Common outcomes:
started,alreadyDebugging,resourceNotRunning,debuggerExtensionMissing,unsupportedResource,unknownAppHost.- Hot Reload
applicable,notApplicable,noEditorControlledResource. - Explain
failureFound,noRecordedFailure.
- Inputs:
- Hot Reload status semantics.
- Enabled doesn't mean applicable.
- Only .NET project resources debugged by this editor qualify. A resource started without the debugger reports
notApplicable. - Externally controlled AppHosts fail closed.
- The fallback order is restart the resource first, then rebuild and restart the AppHost.
- Cross-link from
app-host/hot-reload-and-watch.mdx→ "IDE hot reload and debugging".
- Launch-failure explanation. Only the latest sanitized failure per AppHost is kept, for 30 minutes. The result is a stage, a category, and fixed recommended actions. Raw compiler errors aren't returned; point users to the Output panel and CLI logs.
- Dashboard and Output tools.
- Dashboard works only for editor-controlled running AppHosts, uses the configured presentation (external browser by default), and never returns the URL. It needs no confirmation.
- Output confirms, then selects the "Aspire Extension" channel without reading it.
- Versions. State the minimum extension version for each feature: v1.24.0 for the editor-assistance tools, v1.25.0 for resource attach. Also state that Go attach-later requires 17.0 hosting.
aspire describe(optional). Resource JSON now includesproject.launchCommand(run,watch,ide,direct, ornull),project.configuration, andproject.targetFramework. Source:docs/specs/cli-output-formats.mdin microsoft/aspire.- What's new 17.0. Add a "VS Code extension" entry covering resource attach and the editor-assistance tools, or extend Fill gaps in What's new in Aspire 17.0 #2177.
Suggested locations and outline
get-started/aspire-vscode-extension.mdx- New subsection "Attach a debugger to a running resource", under "The Aspire view" or "Run, debug, and deploy". Cover gaps 1–5.
- Extend the "Language coverage" table with an "Attach to running resource" column: .NET ✔, Go ✔.
- Under the LM tools section, add per-tool input/outcome details, Hot Reload semantics, failure retention, and dashboard/output behavior (gaps 7–11). A collapsible reference is enough.
integrations/frameworks/go/go-host.mdx→ "Debug Go apps" → new "Attach to a running Go resource (VS Code)" subsection (gap 6).app-host/hot-reload-and-watch.mdx→ "IDE hot reload and debugging" → short paragraph and link (gap 8).reference/cli/commands/aspire-describe.mdx→ resource property notes (gap 12, optional).whats-new/aspire-17.mdx(gap 13).
Related
- Document VS Code extension language model tools added in 17.0 #2150 (merged; tool table only), Fill gaps in What's new in Aspire 17.0 #2177 (open; one attach bullet), [docs] Document Go AppHost CodeLens and debugger setup prompt #2070 (open; AppHost debugger setup prompt).
- Add Developer Experience docs: debugging, startup performance, and hot reload #464 (open). Its proposed VS Code manual
launch.jsonattach guidance should reference the built-in Attach debugger action. - [What's New Analysis] Create VS Code extension documentation #348 (open; 13.0 scope, doesn't cover these features).
- Sources:
- Add VS Code resource debugging for .NET and Go aspire#18602
- Add Aspire editor assistance language model tools aspire#19414
- microsoft/aspire
extension/README.md - microsoft/aspire
extension/package.json(contributes.languageModelTools) - microsoft/aspire
src/Aspire.Hosting.Go/README.md - microsoft/aspire
extension/CHANGELOG.md(v1.24.0, v1.25.0)
Reacted by Copilot
Metadata
Metadata
Labels
No labels
Activity
Document VS Code resource attach and editor-assistance language model…
karolz-ms commentedon Nov 17, 2026
Fixed.