Author:"Samer Abdallah"

company:"Xprema Systems"

release_date:"2024-06-30"

ABP Framework Development Skill

Supported AI Coding Platforms

This skill works across all major AI coding assistants. Use the configuration file for your tool:

🚀 Super Agent — Start here for full-feature scaffolding

The `abp-super` agent is the top-level orchestrator. Give it a plain-language description of your feature and it will:

1. Parse entities, properties, and optional features from your description
2. Show you a confirmed analysis table
3. Present a phase-by-phase execution plan with file counts
4. Execute each sub-agent in the correct layer order:

Phase 1 → Domain layer     (entity, domain service, repository interface)
Phase 2 → App.Contracts    (permissions, DTOs, app service interface)
Phase 3 → Application      (app service impl, AutoMapper, specification, background worker, domain events)
Phase 4 → EF Core          (EfCore repository, DbSet, model config, module registration)
Phase 5 → Database         (migration commands)
Phase 6 → UI               (Razor Pages — optional)
Phase 7 → Seed data        (IDataSeedContributor — optional)

For cross-cutting concerns, use the dedicated agents: `abp-multi-tenancy` (tenant isolation), `abp-settings` (setting definitions + read/write), `abp-caching` (distributed cache + Redis).

How to invoke:

Agent Capabilities

Each platform also exposes focused single-responsibility agents for targeted scaffolding. All agents read the relevant reference file(s) and fetch official ABP docs before generating code.

You are an expert ABP Framework developer. Always follow ABP conventions precisely. The user's stack: Razor Pages / MVC UI + EF Core.

How to use this skill

Follow these steps in order for every ABP-related question:

1. Read the local reference file(s) from the table below — they contain curated, correct patterns.
2. Fetch the official documentation page listed in the same row using web_fetch (or a browser tool) to get the latest API details, version-specific notes, or anything the reference file may not cover.
3. Synthesise both sources before generating code or advice.

If a fetch fails (network unavailable), rely on the local reference file and note that the answer is based on cached documentation.

For questions touching multiple areas (e.g. "build a full CRUD feature"), read all relevant files and fetch all relevant documentation pages.

Core ABP Principles (always apply)

1. Layered architecture: Domain → Application → Infrastructure (EF Core) → Web (Razor Pages)
2. Never expose entities to the presentation layer — always use DTOs
3. Business logic lives in entities and domain services, not in application services
4. Application services orchestrate — they call domain services / repositories, map to DTOs
5. Protected/private setters on entity properties — enforce changes through methods
6. Always use `IGuidGenerator` to generate 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, checked in Application Services and Razor Pages

Typical Layered Solution Structure

Acme.MyApp/
├── Acme.MyApp.Domain.Shared/         ← Enums, consts, DTOs shared with clients
├── Acme.MyApp.Domain/                ← Entities, domain services, repo interfaces
├── Acme.MyApp.Application.Contracts/ ← App service interfaces, DTOs, permissions
├── Acme.MyApp.Application/           ← App service implementations
├── Acme.MyApp.EntityFrameworkCore/   ← DbContext, EF Core repo implementations
├── Acme.MyApp.DbMigrator/            ← CLI tool: migrate + seed
├── Acme.MyApp.HttpApi/               ← (optional) manual API controllers
└── Acme.MyApp.Web/                   ← Razor Pages, menus, page models