ABP AI Skills

AI coding skills for the ABP Framework — works with GitHub Copilot, Claude Code, Windsurf, and Continue.dev.

A collection of curated AI agent prompts, slash commands, and workflow definitions that give your AI coding assistant deep, accurate knowledge of ABP Framework patterns. Drop this repository (or copy its config files) into any ABP project and your AI will scaffold production-ready, convention-correct code across every layer.

Author: Samer Abdallah · Company: Xprema Systems

---

Table of Contents

• What’s included
• Quick start
• ⭐ Super Agent — scaffold a full feature in one prompt
• 🔧 Feature Scaffold — wire up an existing entity in one pass
• All agents at a glance
• Platform setup
  • GitHub Copilot
  • Claude Code
  • Windsurf
  • Continue.dev
• Repository structure
• Keeping the skill honest
• Reference files
• Core ABP principles enforced by every agent
• Typical ABP solution structure
• License

---

What’s included

---

Quick start

Option A — one-liner (no clone needed)

macOS / Linux / WSL:

curl -sSL https://raw.githubusercontent.com/smss123/ABP-ai-skills/main/install.sh \
  | bash -s -- /path/to/your-abp-project

Windows PowerShell:

irm https://raw.githubusercontent.com/smss123/ABP-ai-skills/main/install.ps1 | iex
# You will be prompted for the target directory

Option B — from a cloned repo

git clone https://github.com/smss123/ABP-ai-skills.git
cd ABP-ai-skills
./install.sh /path/to/your-abp-project          # macOS/Linux
.\install.ps1 C:\path\to\your-abp-project       # Windows

Install flags

# Claude Code only
./install.sh /path/to/project --platform claude

# Copilot only, overwrite existing
./install.sh /path/to/project --platform copilot --overwrite

2. Open your project in your AI coding assistant.

3. Describe your feature — the Super Agent will do the rest:

---

⭐ Super Agent — scaffold a full feature in one prompt

The abp-super agent is the top-level orchestrator. Give it a plain-language description of what you want to build and it will:

1. Run Phase 0 — context intake before writing a single line: read the existing code through a codebase knowledge graph, read the repo’s plan/design .md files, settle the UI source of truth (connect the Stitch MCP for real screens and tokens if you have it — otherwise your existing UI becomes the reference), then confirm with you what is reused, extended and newly added
2. Parse entities, properties, and optional features (background jobs, specs, UI, seeding) from your description
3. Show a confirmed analysis table — no code is written until you approve
4. Present a full file-by-file execution plan grouped by layer
5. Execute each sub-agent in the correct dependency order:

Phase 0 → Context intake     existing-code graph · plan docs · UI reference (Stitch or your pages) · SOLID check
Phase 1 → Domain layer       entity class · domain service (Manager) · repository interface
Phase 2 → App.Contracts      permission constants · DTOs · app service interface
Phase 3 → Application        app service implementation · AutoMapper · specification · background worker
Phase 4 → EF Core            EfCoreRepository · DbSet · model config · module registration
Phase 5 → Database           EF Core migration commands
Phase 6 → UI (optional)      Razor Pages list + create/edit modals + JS DataTable + menu
Phase 7 → Seed (optional)    IDataSeedContributor with idempotent guard

6. Print a summary: total files generated, layer breakdown, next-steps checklist

Example prompt

“I want to manage Products. Each Product has a Name (required, max 128 chars), a decimal Price, and an IsActive flag. I need Razor Pages UI and some seed data with 3 sample products.”

The Super Agent first runs Phase 0 (it reads your existing code, your plan documents and your current UI, then confirms scope with you), then scaffolds ~15 files across the remaining phases.

---

🔧 Feature Scaffold — wire up an existing entity in one pass

The abp-feature-scaffold agent is the fastest way to add all application-layer best practices to an entity that already exists in the domain layer. It reads the entity file first, extracts real properties and constants, then generates every artifact in the correct order:

Key enforcement rules baked in:

• IRepository.GetAsync auto-throws EntityNotFoundException → HTTP 404 — no manual null-check
• Manager.CreateAsync throws BusinessException with error code on duplicate — no re-check in app service
• [StringLength] always references Consts.MaxXxxLength — never magic numbers
• Business methods only (SetName()) — never direct property assignment

Use this when you’ve already run abp-entity and now need to wire up everything above the domain layer.

---

All agents at a glance

Every capability below ships on all four platforms — a Copilot prompt, a Claude command, a Windsurf workflow and a Continue.dev agent. scripts/verify-skill.sh fails the build if one platform gains or loses a capability, so this table cannot go stale.

Continue.dev users: all agents are available via the agent picker (including the Super Agent at the top of the list).

---

Platform setup

GitHub Copilot

The .github/copilot-instructions.md file is automatically picked up by VS Code Copilot Chat. No extra configuration needed once the files are in your project.

Invoke agents by attaching the prompt file in Copilot Chat:

# In Copilot Chat (VS Code):
@workspace #abp-super.prompt.md Build a product catalog with category filter and Razor Pages UI

All prompt files live in .github/prompts/. Every prompt is set to mode: 'agent' so Copilot can read files, create files, and run commands autonomously.

---

Claude Code

CLAUDE.md at the project root is automatically loaded by Claude Code in every session.

Invoke agents with slash commands:

# Full feature from a scenario:
/project:abp-super Build a blog module with Posts, Tags, Razor Pages UI, and sample seed data

# Individual layers:
/project:abp-entity Post
/project:abp-permissions Posts
/project:abp-razor-page Post
/project:abp-data-seed Post

All commands are in .claude/commands/. The $ARGUMENTS placeholder receives everything you type after the command name.

---

Windsurf

.windsurfrules is automatically loaded by Windsurf as global rules for the workspace.

Invoke workflows in Cascade:

run workflow abp-super
run workflow abp-crud
run workflow abp-razor-page

All workflows are in .windsurf/workflows/. Each workflow follows the same multi-step pattern: read reference files → confirm with user → generate files.

---

Continue.dev

.continue/config.yaml configures the system message, docs indexing, and agents.

Use the agent picker in the Continue sidebar to select:

• ABP Super Agent — full-feature orchestrator
• ABP CRUD Scaffolder, ABP Entity + Domain, ABP App Service, etc.

The config also indexes the official ABP documentation (docs.abp.io) so you can query it with @ABP Framework in chat.

---

Repository structure

ABP-ai-skills/
│
├── AGENTS.md                             ← Auto-activation rules (loaded by Copilot/Codex/Cursor/Zed/Qoder)
├── abp-dev/
│   ├── SKILL.md                        ← Master skill definition (all platforms)
│   └── references/
│       ├── INDEX.md                               ← Routing table: topic → file → verified doc URL (single source)
│       ├── context-intake.md                      ← Phase 0: existing-code graph, plan docs, UI source of truth, SOLID/patterns
│       ├── ddd-domain.md                          ← Entities, AggregateRoot, Domain Services, Repositories
│       ├── ddd-application.md                     ← Application Services, DTOs, CRUD patterns
│       ├── efcore.md                              ← EF Core DbContext, migrations, multi-DBMS switching
│       ├── authorization.md                       ← Permissions, [Authorize], PermissionDefinitionProvider, Audit Logging
│       ├── api.md                                 ← Auto API Controllers, Versioning, Integration Services, Static/Dynamic Proxies
│       ├── ui-razorpages.md                       ← Razor Pages, page models, tag helpers, JS API
│       ├── ui-mvc.md                              ← ASP.NET Core MVC UI, AbpController, _ViewImports, bundling
│       ├── ui-angular.md                          ← Angular SPA: generate-proxy, environment.ts, guards, theming
│       ├── maui.md                                ← .NET MAUI mobile UI (ABP 10 / .NET 10 TFMs, OIDC, adb reverse)
│       ├── cli-structure.md                       ← ABP CLI, startup templates, solution structure
│       ├── background-jobs.md                     ← Background jobs and periodic workers
│       ├── event-bus.md                           ← Local domain events & Distributed Event Bus
│       ├── multi-tenancy.md                       ← IMustHaveTenant, ICurrentTenant, data isolation
│       ├── settings.md                            ← SettingDefinitionProvider, ISettingProvider, ISettingManager
│       ├── caching.md                             ← IDistributedCache, GetOrAddAsync, Entity Cache, Redis setup
│       ├── modules.md                             ← Module system, DependsOn, ConfigureServices, Virtual File Explorer
│       ├── testing-troubleshooting.md             ← Unit/integration testing, common pitfalls
│       ├── localization.md                        ← en.json structure, L[] helper, IStringLocalizer, localization API
│       ├── features.md                            ← IFeatureChecker, FeatureDefinitionProvider, IFeatureManager
│       ├── concurrency-check.md                   ← IHasEntityVersion, optimistic concurrency
│       ├── connection-strings.md                  ← Connection string config, multi-DB, per-tenant DBs
│       ├── data-filtering.md                      ← IDataFilter, ISoftDelete, IMultiTenant, custom filters
│       ├── deployment.md                          ← Production config, SSL, OpenIddict certificates
│       ├── global-features.md                     ← GlobalFeatureManager, [RequiresGlobalFeature]
│       ├── image-manipulation.md                  ← IImageCompressor, IImageResizer, ImageSharp/Magick/SkiaSharp
│       ├── interceptors.md                        ← AbpInterceptor, OnRegistered, DynamicProxy
│       ├── json.md                                ← IJsonSerializer, System.Text.Json vs Newtonsoft
│       ├── object-extensions.md                   ← ObjectExtensionManager, Module Entity Extensions
│       ├── options.md                             ← Options pattern, Configure, PreConfigure
│       ├── signalr.md                             ← SignalR real-time communication
│       ├── string-encryption.md                   ← IStringEncryptionService, AbpStringEncryptionOptions
│       ├── text-templating.md                     ← Scriban & Razor engines, ITemplateRenderer, email templates
│       ├── theming.md                             ← UI Theming, layout system, theme customization
│       ├── timing.md                              ← IClock, DateTimeKind, timezone, AbpClockOptions
│       ├── correlation-id.md                      ← ICorrelationIdProvider, AbpCorrelationIdOptions, propagation
│       ├── cms-kit.md                             ← CMS Kit module: blogs, pages, comments, reactions, tags
│       ├── openiddict.md                          ← OpenIddict module: OAuth endpoints, token lifetimes, claims
│       ├── database-tables.md                     ← Module DB table prefixes, connection string names
│       ├── ui-blazor.md                           ← Blazor WASM/Server/WebApp: components, theming, proxies
│       ├── microservices.md                       ← Microservice solution: apps/gateways/services, YARP, RabbitMQ
│       ├── blob-storing.md                        ← IBlobContainer, providers, encryption, pipelines
│       ├── audit-logging.md                       ← AuditLog/EntityChange, AbpAuditingOptions, security logs
│       ├── openapi-swagger.md                     ← Volo.Abp.Swashbuckle, AddAbpSwaggerGen, OIDC document
│       ├── background-workers.md                  ← AsyncPeriodicBackgroundWorkerBase, dynamic/cron workers
│       ├── production-hardening.md                ← Production checklist: prefixes, keys, headers, secrets
│       ├── react-native.md                        ← React Native / Expo mobile UI
│       └── migration-identityserver-openiddict.md ← IdentityServer4 → OpenIddict migration guide
│
├── .github/
│   ├── copilot-instructions.md         ← Copilot global instructions (auto-loaded)
│   ├── instructions/
│   │   └── abp.instructions.md         ← path-scoped ABP rules (`applyTo` globs: .cs/.csproj/.cshtml/…)
│   ├── prompts/                        ← one file per capability (see "All agents at a glance")
│   │   └── abp-*.prompt.md                abp-super, abp-developer, abp-crud, abp-entity, …
│   └── workflows/
│       └── verify-skill.yml            ← CI for the skill itself; never copied into a target project
│
├── .claude/
│   └── commands/                       ← the same capabilities as /project:abp-* commands
│
├── .windsurf/
│   └── workflows/                      ← the same capabilities as Cascade workflows
│
├── .continue/
│   └── config.yaml                     ← System message + docs index + all agents (`# id:` per agent)
│
├── scripts/
│   └── verify-skill.sh                 ← Self-verification harness (`make verify`, `make links`)
│
├── install.sh / install.ps1            ← Installers for macOS·Linux / Windows
├── Makefile                            ← make install · make verify · make links
├── AGENT.md                            ← Machine-readable install guide for AI agents
├── .windsurfrules                      ← Windsurf global rules (auto-loaded)
├── CLAUDE.md                           ← Claude Code global instructions (auto-loaded)
├── LICENSE
└── README.md                           ← This file

---

Keeping the skill honest

This repository verifies itself. make verify runs scripts/verify-skill.sh, and the same script runs in CI (.github/workflows/verify-skill.yml) on every push and pull request:

A separate CI job installs the skill into a synthetic ABP project and asserts the resulting tree — including that the skill’s own .github/workflows/ is never copied into someone’s repository. Documentation liveness (make links) runs weekly rather than on every push, so a transient abp.io outage cannot block a merge.

---

Reference files

Every agent runs Phase 0 (references/context-intake.md) before generating code, then reads references/INDEX.md — it maps each topic to its reference file and to a documentation URL that is verified live — then reads the mapped file and fetches the official ABP docs URL when the network is available.

Each reference file declares the ABP version it targets and the date its documentation was last verified in a frontmatter block (applies_to_abp / doc_verified_on); make links (or bash scripts/verify-skill.sh --links) HEAD-checks every abp.io URL the skill references, so a moved doc page shows up as a failure instead of as bad code generation.

---

Core ABP principles enforced by every agent

Every agent in this repository enforces these rules — they are non-negotiable in generated code:

0. Phase 0 — context intake before any code — read the existing code through a knowledge graph, read the repo’s plan/design markdown, settle the UI source of truth (Stitch MCP if connected, otherwise the project’s existing UI as the reference), confirm scope with the user, then apply SOLID — see abp-dev/references/context-intake.md
1. Layered architecture — Domain → Application → Infrastructure (EF Core) → UI (MVC / Razor Pages / Angular / Blazor / MAUI), detected from the target project
2. Never expose entities to the presentation layer — always map to DTOs with ObjectMapper.Map<>()
3. Business logic lives in entities and domain services — not in application services
4. Application services orchestrate — they call domain services / repositories and return DTOs
5. Private/protected setters on all entity properties — mutate state through business methods
6. Always use IGuidGenerator to create Guid IDs — never Guid.NewGuid() directly
7. Auto-register services — ABP discovers ITransientDependency, ISingletonDependency, IScopedDependency automatically
8. ConfigureByConvention() must always be called in EF Core model configuration
9. Permissions are defined in Application.Contracts, enforced with [Authorize] in app services and in whichever UI the project uses
10. IDataSeedContributor must be idempotent — guard with GetCountAsync() > 0 before inserting
11. Reuse before adding — extend an existing entity, domain service, permission group or UI pattern instead of creating a parallel second one

---

Typical ABP solution structure

Acme.MyApp/
├── Acme.MyApp.Domain.Shared/         ← Enums, consts, error codes shared with clients
├── Acme.MyApp.Domain/                ← Entities, domain services, repository interfaces
├── Acme.MyApp.Application.Contracts/ ← App service interfaces, DTOs, permission constants
├── Acme.MyApp.Application/           ← App service implementations, AutoMapper profiles
├── Acme.MyApp.EntityFrameworkCore/   ← DbContext, EF Core repository implementations
├── Acme.MyApp.DbMigrator/            ← CLI tool: run migrations + seed data
├── Acme.MyApp.HttpApi/               ← (optional) manual API controllers
└── Acme.MyApp.Web/                   ← Razor Pages, menus, bundling

---

License

MIT