microsoft/aspire · Archived
Guides authoring and reviewing Aspire.Hosting integration APIs.
npx skills add microsoft/aspire --skill hosting-integration-authoring
This repository is archived — consider an actively maintained alternative.
Create a pull request using the repository PR template. Use when asked to: create PR, open PR, …
12 installsReviews .NET API surface area PRs for design guideline violations.
12 installsReproduces and fixes flaky or quarantined tests.
11 installsUse only when the user explicitly requests a deep Aspire architectural or pattern review of an …
10 installsRelated neighbors and high-traction skills in the same topics — useful to compare before installing.
Debug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe …
568.9K installsPre-deployment validation for Azure readiness. Run deep checks on configuration, infrastructure…
567.7K installsBrowser automation CLI for AI agents. Use when the user needs to interact with websites, includ…
810.4K installsBuild, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …
576.5K installsExecute Azure deployments for ALREADY-PREPARED applications that have existing .azure/deploymen…
568.2K installsGuides Microsoft Entra ID app registration, OAuth 2.0 authentication, and MSAL integration. USE…
566.9K installsOther skills from microsoft/aspire · top by installs.
npx skills add microsoft/aspire
Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.
main
Files included with this skill beyond the listing page.
SKILL.md
6,388 B
SUMMARY.md
336 B
Use this skill when creating, modifying, or reviewing Aspire.Hosting.* integration APIs.
This skill is self-contained. The resource files in this skill are the authoritative guidance, and repository paths are examples of existing patterns only.
Read resources/selector-matrix.md first. Then read resources/app-model-fundamentals.md for the app model rules that apply to every hosting integration. Classify the work across all four axes:
Do not force the integration into a single bucket. Most integrations compose several patterns. For example, PostgreSQL is a container-backed service, has parent-child database resources, exposes connection properties, creates databases during resource readiness, and has admin UI companion helpers.
Always read the relevant archetype resource and the cross-cutting resources that apply to the change.
| If the integration involves | Read |
|---|---|
| Any resource, annotation, lifecycle event, structured value, endpoint, manifest, or app-model behavior | resources/app-model-fundamentals.md |
| Local container service, database, broker, cache, vector DB | resources/archetype-container-backed-service.md |
| Admin UI, inspector, dashboard, load/test tool, or standalone utility container | resources/archetype-admin-and-tool-container.md |
| Migration, package/tool install, model pull, schema deployment, DACPAC, or one-shot setup helper | resources/archetype-setup-and-migration-helper.md |
| Serialized controller, reconciler, command-driven resource operations, drift detection, or state-machine orchestration | resources/archetype-controller-reconciler.md |
| Sidecar, component registry, telemetry collector, service mesh, middleware, or app-wide annotation-driven infrastructure | resources/archetype-sidecar-and-middleware.md |
| Local tunnel, webhook forwarder, callback bridge, or CLI that exposes/forwards local endpoints | resources/archetype-tunnel-and-webhook-bridge.md |
| Secret manager, credential broker, external secret provider, or provider-backed managed secret child resources | resources/archetype-secret-provider.md |
| External/SaaS service reference with API key/endpoint, no local container/provisioning | resources/archetype-external-cloud-reference.md |
| Azure resource provisioning, Bicep, role assignments, existing Azure resources, emulators, local containers for Azure resources | resources/archetype-azure-provisioning.md |
| Docker Compose, Kubernetes, Azure Container Apps, or another deployment target/publisher | resources/archetype-deployment-target-publisher.md and resources/deployment-production-readiness.md |
| Python, Go, JavaScript, Node, Vite, Next.js, or another language runtime/workload | resources/archetype-language-executable-app.md |
| Non-resource model/configuration overlay, e.g. Orleans-style APIs | resources/archetype-overlay-configuration.md |
| Public API names, overloads, return types, polyglot AppHost compatibility, annotations, experimental state | resources/api-naming-and-shape.md |
| Any run/publish/deploy branching | resources/run-publish-deploy-modes.md |
| Event subscriptions, initialization, generated files, health checks, pipeline steps | resources/eventing-and-initialization.md |
| Custom resource lifetime, synthetic/facade resources, manually allocated endpoints, or resource notification state machines | resources/custom-lifecycle-and-facade-resources.md |
IResourceWithConnectionString, WithReference, environment variables, URI/JDBC properties |
resources/connection-properties.md |
Parent-child resources, companions, setup siblings, WithReference, waits, relationships |
resources/relationships-and-companions.md |
[AspireExport], TypeScript/polyglot AppHosts, ATS metadata, analyzer diagnostics, DTOs, union parameters, value catalogs, callback contexts |
resources/polyglot-exports.md |
| Endpoint names, service discovery, external URLs, reference endpoints, endpoint environment variables | resources/endpoints-and-service-discovery.md |
| Secrets, parameters, credentials, managed identity, RBAC, private networking, generated artifacts containing sensitive data | resources/security-secrets-and-identity.md |
| Resource names, physical names, annotations, constructors, mutability, model invariants | resources/resource-model-invariants.md |
Package metadata, preview/stable posture, aspire add discovery, icons, gallery/README visibility |
resources/package-and-discoverability.md |
| Dashboard icons, URLs, commands, notifications, resource logs, admin companion UX | resources/dashboard-ux.md |
Generated config files, WithContainerFiles, file permissions, temp/store usage, build dependencies |
resources/generated-files-and-container-files.md |
| Toolchain detection, path handling, Windows/macOS/Linux behavior, shell quoting, executable permissions | resources/cross-platform-tooling.md |
| Experimental/obsolete/deprecation lifecycle, compatibility shims, migration guidance | resources/compatibility-and-deprecation.md |
| README or tests | resources/testing-and-readmes.md |
/api/.cs untouched unless the task explicitly asks for API baseline regeneration.When reviewing an integration PR, look for concrete violations that can cause wrong runtime behavior, wrong generated manifests, broken deployment output, bad public API, missing connection properties, or bad polyglot projection. Do not spend review budget on style-only comments.