ABP AI Skills

AI coding skills for the [ABP Framework](https://abp.io) — 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
• 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. Parse entities, properties, and optional features (background jobs, specs, UI, seeding) from your description
2. Show a confirmed analysis table — no code is written until you approve
3. Present a full file-by-file execution plan grouped by layer
4. Execute each sub-agent in the correct dependency order:

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

1. 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 will scaffold ~15 files across all 7 phases without any further input.

🔧 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
• <Entity>Manager.CreateAsync throws BusinessException with error code on duplicate — no re-check in app service
• [StringLength] always references <Entity>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

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/
│
├── abp-dev/
│   ├── SKILL.md                        ← Master skill definition (all platforms)
│   └── references/
│       ├── 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
│       ├── 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<T>, 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<T>, 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
│       ├── maui.md                                ← .NET MAUI mobile UI, OIDC, adb reverse
│       ├── 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)
│   └── prompts/
│       ├── abp-super.prompt.md         ⭐ Super agent
│       ├── abp-crud.prompt.md
│       ├── abp-entity.prompt.md
│       ├── abp-domain-service.prompt.md
│       ├── abp-repository.prompt.md
│       ├── abp-app-service.prompt.md
│       ├── abp-permissions.prompt.md
│       ├── abp-specification.prompt.md
│       ├── abp-background-worker.prompt.md
│       ├── abp-razor-page.prompt.md
│       ├── abp-data-seed.prompt.md
│       ├── abp-event-bus.prompt.md
│       ├── abp-multi-tenancy.prompt.md
│       ├── abp-settings.prompt.md
│       ├── abp-caching.prompt.md
│       └── abp-feature-scaffold.prompt.md
│
├── .claude/
│   └── commands/
│       ├── abp-super.md                ⭐ /project:abp-super
│       ├── abp-crud.md
│       ├── abp-entity.md
│       ├── abp-domain-service.md
│       ├── abp-repository.md
│       ├── abp-app-service.md
│       ├── abp-permissions.md
│       ├── abp-specification.md
│       ├── abp-background-worker.md
│       ├── abp-razor-page.md
│       ├── abp-data-seed.md
│       ├── abp-event-bus.md
│       ├── abp-multi-tenancy.md
│       ├── abp-settings.md
│       ├── abp-caching.md
│       └── abp-feature-scaffold.md
│
├── .windsurf/
│   └── workflows/
│       ├── abp-super.md                ⭐ run workflow abp-super
│       ├── abp-crud.md
│       ├── abp-entity.md
│       ├── abp-domain-service.md
│       ├── abp-repository.md
│       ├── abp-app-service.md
│       ├── abp-permissions.md
│       ├── abp-specification.md
│       ├── abp-background-worker.md
│       ├── abp-razor-page.md
│       ├── abp-data-seed.md
│       ├── abp-event-bus.md
│       ├── abp-multi-tenancy.md
│       ├── abp-settings.md
│       ├── abp-caching.md
│       └── abp-feature-scaffold.md
│
├── .continue/
│   └── config.yaml                     ← System message + docs index + all agents
│
├── .windsurfrules                      ← Windsurf global rules (auto-loaded)
├── CLAUDE.md                           ← Claude Code global instructions (auto-loaded)
├── LICENSE
└── README.md                           ← This file

Reference files

Every agent reads the relevant reference file(s) before generating any code, and fetches the official ABP docs URL when the network is available.

Core ABP principles enforced by every agent

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

1. Layered architecture — Domain → Application → Infrastructure (EF Core) → Web (Razor Pages)
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 Razor Pages
10. `IDataSeedContributor` must be idempotent — guard with GetCountAsync() > 0 before inserting

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