hosting-integration-authoring
Skill632 starsChanged 4 days agoMITView on GitHub
Guides authoring and reviewing CommunityToolkit Aspire.Hosting integration APIs. Classifies integration archetypes, then applies self-contained best practices for naming, resource shape, run/publish/deploy behavior, eventing, connection properties, security, endpoint semantics, polyglot exports, READMEs, and tests.
2 other projects use a version of this, 2 of them edited.
Adopted by
Most recently taken up by
- dotnet/aspireedited, first seen Oct 8, 2026
- microsoft/aspireedited, first seen May 27, 2026
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 2
- dotnet/aspire★ 6.4k99% same
- microsoft/aspire★ 6.4k99% same
Wrote their own version · 0
None found.
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- aspire-typescript-apphostSkill
- aspire-upgradeSkill
- client-integration-authoringSkill
- dotnet-inspectSkill
- playwright-cliSkill
The file
We split this skill into the rules it gives an agent
6 rules. About 0 are common, 3 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Use this skill when creating, modifying, or reviewing CommunityToolkit.Aspire.Hosting.* hosting integration packages and related …
- Very specific: line 14
Read resources/selector-matrix.md first.
- Distinctive: line 21
Do not force the integration into a single bucket.
- Distinctive: line 25
Always read the relevant archetype resource and the cross-cutting resources that apply to the change.
- Very specific: line 65
Keep generated API baseline files under */api/*.cs untouched unless the task explicitly asks for API baseline regeneration.
- Distinctive: line 69
When reviewing an integration PR, look for concrete violations that can cause wrong runtime behavior, wrong generated manifests, broken …
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Aspire hosting integration authoring
Use this skill when creating, modifying, or reviewing CommunityToolkit.Aspire.Hosting.* hosting integration packages and related Aspire.Hosting.* 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.
First step: classify the integration
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:
- Resource shape.
- Lifecycle mode.
- Integration role.
- Structure.
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.
Then read the matching resources
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 |
Authoring workflow
- State the classification briefly before changing or reviewing code.
- Apply the archetype-specific DO/DON'T list.
- Apply every relevant cross-cutting checklist.
- Validate both run-mode and publish/deploy behavior when the integration changes those surfaces.
- Keep generated API baseline files under
*/api/*.csuntouched unless the task explicitly asks for API baseline regeneration.
Review workflow
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.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.