ABP IO

This MCP server enables you to connect your ABP.IO applications to AI models, giving you access to 48+ tools for managing applications, modules, entities, users, tenants, UI, and more. It supports flexible deployment options and works with your existing ABP.IO setup to streamline development and automation tasks.

How to use

You run the MCP server locally or in your infrastructure and connect clients via the MCP protocol. Use a client to request management actions, UI generation, and data operations against your ABP.IO applications. Start the server in a mode that requires authentication for full access, or use an informational mode to explore capabilities and generate UI templates without needing to access your live app.

How to install

Prerequisites you need before installing:

• Node.js 18 or higher
• Access to an ABP.IO application with API endpoints
• API key or authentication token for your ABP application

# 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

Additional installation options

If you prefer a global installation or a local development setup, you have options that use the same MCP server binary.

# Global installation
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

Local development workflow

If you want to build and run the MCP server from source for active development, follow this flow.

# 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 (full mode)
npm run dev -- --api-key=YOUR_API_KEY --base-url=https://your-abp-app.com --stdio

Available tools

abp_get_applications

Retrieve all ABP applications you have access to.

abp_get_application

Fetch details for a specific ABP application by ID.

abp_create_application

Create a new ABP application with specified template and framework.

abp_update_application

Update properties of an existing ABP application.

abp_delete_application

Delete an ABP application.

abp_get_modules

List installed ABP modules for your applications.

abp_get_module

Get detailed information about a specific module by ID.

abp_install_module

Install a new ABP module into an application.

abp_uninstall_module

Uninstall a module from an application.

abp_get_popular_modules

Show commonly used ABP modules for quick enrollment.

abp_get_entities

List domain entities within an application.

abp_get_entity

Retrieve a single entity definition by ID.

abp_create_entity

Create a new domain entity with properties and relationships.

abp_generate_crud

Automatically generate CRUD operations for an entity.

abp_get_users

List users across your ABP applications.

abp_get_user

Get details for a specific user by ID.

abp_create_user

Create a new user with credentials and roles.

abp_update_user

Update user information and permissions.

abp_delete_user

Delete a user from the system.

abp_get_tenants

List tenants for multi-tenant applications.

abp_get_tenant

Get details for a tenant by ID.

abp_create_tenant

Create a new tenant with edition and status.

abp_update_tenant

Update tenant settings and status.

abp_delete_tenant

Remove a tenant.

abp_get_permissions

List all permissions available in the system.

abp_get_permissions_by_group

Show permissions grouped under a particular category.

abp_grant_permission

Grant a permission to a role or user.

abp_revoke_permission

Revoke a permission from a role or user.

abp_get_audit_logs

Query audit logs for activities across the system.

abp_get_audit_log

Fetch a single audit log by ID.

abp_get_audit_summary

Get summary statistics for audit events.

abp_get_background_jobs

List background jobs and their statuses.

abp_get_background_job

Get details for a specific background job.

abp_enqueue_background_job

Enqueue a new background job for processing.

abp_delete_background_job

Remove a background job record.

abp_get_common_job_types

Show common types of background jobs available.

abp_generate_page

Generate UI pages (list, detail, create, edit, modal) for frameworks.

abp_get_themes

List available UI themes for customization.

abp_get_theme

Get details for a specific UI theme.

abp_apply_theme

Apply and customize a theme across the application.

abp_generate_component

Generate reusable UI components like widgets and modals.

abp_get_layouts

List all available layouts for pages.

abp_get_layout

Get details for a particular layout.

abp_update_layout

Update layout configuration.

abp_get_menus

List application menus.

abp_get_menu

Get details for a specific menu.

abp_add_menu_item

Add a menu item with permissions and icons.

abp_remove_menu_item

Remove a menu item.

abp_get_widgets

List dashboard widgets.

abp_get_widget

Get details for a widget.

abp_create_widget

Create a new dashboard widget.

abp_update_widget

Update a widget configuration.

abp_delete_widget

Delete a widget.

abp_generate_form

Generate complex forms with validation.

abp_get_localization_resources

List localization resources across cultures.

abp_get_localization_resource

Get a specific localization resource by culture and key.

abp_update_localization_text

Update localized text across cultures.

abp_get_supported_cultures

Show all supported cultures for localization.