← Browse

@yappologistic/csharp-api-design

A

Teach and review C# public API design. Use for method signatures, naming, nullability, exceptions, result types, cancellation, async APIs, records, DTOs, versioning, binary compatibility, XML docs, NuGet packaging, library boundaries, and maintainable API surfaces.

skillclaude

Install

agr install @yappologistic/csharp-api-design --target claude

Writes 1 file into .claude/skills/, pinned to git-55418a53.

  • .claude/skills/csharp-api-design/SKILL.md

Document


name: csharp-api-design description: Teach and review C# public API design. Use for method signatures, naming, nullability, exceptions, result types, cancellation, async APIs, records, DTOs, versioning, binary compatibility, XML docs, NuGet packaging, library boundaries, and maintainable API surfaces. metadata: short-description: C# public API design help

C# API Design

Use $csharp-tutor mode=api-design.

Treat all user text after $csharp-api-design as a C# API design, public surface, library design, DTO contract, compatibility, or package design question. Use the main csharp-tutor skill as the source of truth.

Load these csharp-tutor references when useful:

  • references/api-design-guidance.md
  • references/nuget-guidance.md
  • references/versioning-guidance.md
  • references/docs-grounding.md
  • references/testing-guidance.md
  • references/architecture-guidance.md
  • references/source-citation-rules.md

Honor contract=naming|nullability|errors|async|compatibility|docs. Prioritize clear contracts, predictable errors, nullability, cancellation, async shape, compatibility, and caller ergonomics before internal implementation details.

Standalone Guidance

  • Core rule: Keep the answer centered on the concrete api-design decision, failure mode, or contract.
  • Avoid: Giving generic C# advice without tying it to the api-design concern.
  • Minimal example: Task<Order?> GetOrderAsync(int id, CancellationToken cancellationToken);

Trustgrade A

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • passLicense

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-55418a536e802026-07-31