client-integration-authoring
Skill632 starsChanged 4 days agoMITView on GitHub
Guides authoring and reviewing CommunityToolkit Aspire client integrations, including registration shape, configuration, keyed services, health checks, telemetry, READMEs, examples, and tests.
In this repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/copilot-instructions.mdCopilot instructions
- aspire-typescript-apphostSkill
- aspire-upgradeSkill
- dotnet-inspectSkill
- hosting-integration-authoringSkill
- playwright-cliSkill
The file
We split this skill into the rules it gives an agent
10 rules. About 0 are common, 7 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
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
- could be automatic: a setting could enforce it
- Very specific: line 8
Use this skill when creating, modifying, or reviewing CommunityToolkit.Aspire.* client integration packages whose extension methods …
- Distinctive: line 16
Registration shape: default service, keyed service, custom service key, or a fluent builder.
- Distinctive: line 19
Do not force every integration into one template.
- Distinctive: line 26
Add default and keyed registration only when both are useful and can behave consistently.
- Distinctive: line 27
Add health checks and telemetry only when the integration can implement them reliably.
- Distinctive: line 28
Add focused tests and documentation using testing and documentation.
- Very specific: line 29
Add source, test, and example projects to CommunityToolkit.Aspire.slnx when new projects are created.
- Very specific: line 38
Do not create or manually edit generated */api/*.cs files.
- Distinctive: line 40
Keep health checks lightweight and cancellation-aware.
- Distinctive: line 41
Avoid adding health-check, telemetry, or HTTP dependencies when the integration does not use them.
≈ “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 client integration authoring
Use this skill when creating, modifying, or reviewing CommunityToolkit.Aspire.* client integration packages whose extension methods register consuming-application services.
First step: classify the integration
Inspect nearby client integrations and classify the requested work:
- Client lifetime: singleton, scoped, transient, SDK-managed, or
HttpClient-backed. - Configuration source: connection string, configuration section, explicit settings, or a combination.
- Registration shape: default service, keyed service, custom service key, or a fluent builder.
- Optional concerns: health checks, tracing/metrics, Microsoft.Extensions.AI adapters, Native AOT, or multiple logical clients.
Do not force every integration into one template. Read patterns and apply only the capabilities supported by the underlying client library and demonstrated by nearby integrations.
Authoring workflow
- Inspect two existing client integrations with the closest registration and configuration shape.
- Define the smallest public API that follows the underlying SDK and repository conventions.
- Implement settings binding, connection-string override, and the configuration callback in a predictable order.
- Add default and keyed registration only when both are useful and can behave consistently.
- Add health checks and telemetry only when the integration can implement them reliably.
- Add focused tests and documentation using testing and documentation.
- Add source, test, and example projects to
CommunityToolkit.Aspire.slnxwhen new projects are created. - Validate with the narrowest relevant build and test commands.
Non-negotiable conventions
- Client extension methods use the
Microsoft.Extensions.Hostingnamespace. - Client packages use
CommunityToolkit.Aspire.[IntegrationName]naming and include theclientpackage tag. - Public APIs require XML documentation.
- Validate public inputs with the throw helpers used by nearby integrations.
- Do not create or manually edit generated
*/api/*.csfiles. - Fail with a clear configuration error when a client cannot be constructed unless an established integration pattern intentionally defers missing-configuration handling; do not silently create an invalid client.
- Keep health checks lightweight and cancellation-aware.
- Avoid adding health-check, telemetry, or HTTP dependencies when the integration does not use them.
Review workflow
Review for behavioral correctness rather than template conformity:
- configuration precedence and missing-configuration behavior;
- service lifetime and keyed/default symmetry;
- duplicated registrations or health checks;
- disposal and
HttpClientusage; - telemetry opt-out behavior;
- health-check names, timeouts, and failure handling;
- README examples that match the actual API; and
- tests that cover the supported registration shapes.
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.

