README.md
Enables AI models to interact with ABP.IO applications through over 48 tools.
ABP.IO MCP Server
A comprehensive Model Context Protocol (MCP) server for ABP.IO that enables AI models to interact with your ABP applications. Provides 48+ tools for managing modules, entities, users, tenants, UI development, and more.
What is ABP.IO?
ABP.IO is a comprehensive open-source web application development framework for ASP.NET Core that provides:
- Modern Architecture: Based on Domain-Driven Design (DDD) and Clean Architecture principles
- Modular Design: Pre-built modules for common features (Identity, SaaS, CMS, etc.)
- Multi-tenancy Support: Built-in SaaS capabilities
- Multiple UI Options: Supports MVC, Angular, Blazor, React Native
- Development Tools: ABP Studio, ABP Suite for rapid development
- Microservice Compatible: Supports both monolithic and microservice architectures
Features
This comprehensive MCP server provides 48+ tools covering all aspects of ABP.IO development, from backend services to complete UI development:
🏗️ Application Management
- Create, read, update, delete ABP applications
- Support for different templates (app, microservice, module, console)
- Multiple UI frameworks (MVC, Angular, Blazor, etc.)
- Database provider options (Entity Framework, MongoDB, Dapper)
📦 Module Management
- Install and uninstall ABP modules
- Browse popular ABP modules
- Manage module dependencies
- View module information and documentation
🗃️ Entity Management
- Create and manage domain entities
- Define entity properties and relationships
- Generate CRUD operations automatically
- Support for DDD patterns (aggregates, value objects)
👥 User Management
- Complete user lifecycle management
- Role-based access control
- User filtering and search
- Active/inactive user management
🏢 Tenant Management (Multi-tenancy)
- Create and manage tenants for SaaS applications
- Tenant-specific configurations
- Subscription management
- Database separation strategies
🔐 Permission Management
- Fine-grained permission system
- Role and user-based permissions
- Permission groups and hierarchies
- Grant/revoke permissions dynamically
📋 Audit Logging
- Comprehensive audit trail
- Performance monitoring
- Error tracking and analysis
- Custom audit log reports
⚙️ Background Jobs
- Job queue management
- Common ABP background job types
- Job scheduling and monitoring
- Failed job handling
🎨 UI Development
- Generate pages (list, detail, create, edit, modal) for multiple frameworks
- Theme management and customization
- Reusable component generation (widgets, modals, partials, directives, pipes)
- Layout management and customization
- Navigation menu management
- Dashboard widget creation and management
- Complex form generation with validation
- Multi-language localization support
Prerequisites
- Node.js 18 or higher
- Access to an ABP.IO application with API endpoints
- API key or authentication token for your ABP application
Installation
Method 1: Using NPX (Recommended)
No installation required! Just use npx to run the latest version:
# Full mode (requires API key)
npx abp-io-mcp-server --api-key=YOUR_API_KEY --base-url=https://your-abp-app.com --stdio
# Info-only mode (no API key required)
npx abp-io-mcp-server --info-only-mode --stdio
Method 2: Global Installation
# Install globally
npm install -g abp-io-mcp-server
# Run in full mode
abp-io-mcp-server --api-key=YOUR_API_KEY --base-url=https://your-abp-app.com --stdio
# Run in info-only mode
abp-io-mcp-server --info-only-mode --stdio
Method 3: Local Development
# Clone the repository
git clone https://github.com/cyrilnoah1/abp-io-mcp.git
cd abp-io-mcp
# Install dependencies
npm install
# Build the project
npm run build
# Run the server
npm run dev -- --api-key=YOUR_API_KEY --base-url=https://your-abp-app.com --stdio
Configuration
Required Parameters
--stdio: Use stdio transport for MCP clients
Authentication Parameters
--api-key: Your ABP application API key (required for full functionality)--base-url: Base URL of your ABP application (default: http://localhost:44300)--info-only-mode: Enable only informational tools that don't require API authentication
Operating Modes
The ABP MCP Server supports two operating modes:
🔐 **Full Mode** (Default)
- Requires
--api-keyparameter - Provides access to all 48+ tools
- Can perform all operations on your ABP application
- Recommended for development and production use
abp-io-mcp-server --stdio --api-key=YOUR_API_KEY --base-url=https://your-abp-app.com
📚 **Info-Only Mode**
- No API key required
- Provides 13 informational and UI generation tools
- Includes ABP documentation, best practices, troubleshooting guides
- Generate UI component templates for Angular, Blazor, and MVC
- Perfect for exploring ABP concepts and creating code templates without a running application
abp-io-
Tools (6)
manage_modulesInstall, uninstall, and browse ABP modules and dependencies.manage_entitiesCreate and manage domain entities, properties, and CRUD operations.manage_usersHandle user lifecycle, roles, and access control.manage_tenantsCreate and manage tenants for SaaS applications and database separation.ui_generationGenerate pages and components for Angular, Blazor, and MVC frameworks.audit_loggingAccess audit trails, performance monitoring, and error tracking.Environment Variables
api-keyrequiredYour ABP application API key (required for full mode)base-urlBase URL of your ABP applicationinfo-only-modeEnable only informational tools that don't require API authenticationConfiguration
claude_desktop_config.json
{
"mcpServers": {
"abp-io": {
"command": "npx",
"args": [
"-y",
"abp-io-mcp-server",
"--api-key=YOUR_API_KEY",
"--base-url=https://your-abp-app.com",
"--stdio"
]
}
}
}Try it
→Create a new domain entity named 'Product' with properties for Name, Price, and SKU.
→Generate a CRUD UI page for the 'Customer' entity using the Angular framework.
→List all active tenants in my SaaS application and their subscription status.
→Install the Identity module into my current ABP application.
→Show me the recent audit logs for failed login attempts.