app-builder-mcp-server
Version:
MCP server for Adobe App Builder CLI commands
149 lines (107 loc) • 4.4 kB
Markdown
# App Builder MCP Server
This Model Context Protocol (MCP) server provides an interface to interact with the Adobe App Builder CLI (`aio`) commands directly from compatible AI assistants. It allows AI agents to perform App Builder operations like initializing, building, deploying, and managing applications.
## Features
- Create and initialize new Adobe App Builder applications
- Build, deploy, and run App Builder apps
- Manage actions, packages, triggers, and rules
- Monitor activations and logs
- Add web assets and actions to applications
## Prerequisites
- Adobe App Builder CLI (`aio`) installed globally
- Node.js 16 or higher
- Valid Adobe Developer credentials for some operations
## Installation & Usage
### Using with npx (recommended)
```bash
npx app-builder-mcp-server --projectPath /path/to/your/project
```
### Installing globally
```bash
npm install -g app-builder-mcp-server
app-builder-mcp-server --projectPath /path/to/your/project
```
### Installing as a development dependency
```bash
npm install --save-dev app-builder-mcp-server
```
Then in your package.json:
```json
"scripts": {
"mcp-server": "app-builder-mcp-server --projectPath ."
}
```
Run with:
```bash
npm run mcp-server
```
## Required Parameters
- `--projectPath` or `-p`: Path to your Adobe App Builder project directory
## Configuring with Cursor
To use this MCP server with Cursor, you need to add the following configuration to your Cursor settings:
```json
{
"mcpServers": {
"app-builder": {
"command": "npx",
"args": [
"app-builder-mcp-server",
"--projectPath",
"/path/to/app-builder-project"
]
}
}
}
```
Replace `/path/to/app-builder-project` with the actual path to your Adobe App Builder project.
After configuration you can interract with agent using commands such as:
"get actions list"
"initialize an app builder project"
"deploy app builder project"
"login to sandbox environment"
"create hello world action"
## Available Commands
The server exposes the following Adobe App Builder CLI commands via MCP:
#### App Lifecycle Commands
- `app-init`: Initialize a new Adobe App Builder application
- `app-build`: Build an Adobe App Builder application
- `app-deploy`: Deploy an Adobe App Builder application
- `app-undeploy`: Undeploy an Adobe App Builder application
- `app-run`: Run an Adobe App Builder application locally
- `app-test`: Run tests for an Adobe App Builder application
- `app-logs`: Get logs for an Adobe App Builder application
- `app-info`: Get information about an Adobe App Builder application
- `app-get-url`: Get the URL for an Adobe App Builder application action
#### Runtime Commands
- `rt-action-list`: List Adobe App Builder actions
- `rt-action-create`: Create an Adobe App Builder action
- `rt-action-update`: Update an Adobe App Builder action
- `rt-action-delete`: Delete an Adobe App Builder action
- `rt-action-invoke`: Invoke an Adobe App Builder action
- `rt-action-get`: Get details of an Adobe App Builder action
- `rt-package-list`: List Adobe App Builder packages
- `rt-package-create`: Create an Adobe App Builder package
- `rt-package-update`: Update an Adobe App Builder package
- `rt-package-delete`: Delete an Adobe App Builder package
- `rt-package-get`: Get details of an Adobe App Builder package
- `rt-activation-list`: List Adobe App Builder activations
- `rt-activation-get`: Get details of an Adobe App Builder activation
- `rt-activation-logs`: Get logs of an Adobe App Builder activation
- `rt-activation-result`: Get result of an Adobe App Builder activation
- `rt-deploy`: Deploy Adobe App Builder entities
- `rt-trigger-list`: List Adobe App Builder triggers
- `rt-rule-list`: List Adobe App Builder rules
#### Other Commands
- `info`: Get Adobe App Builder CLI information
- `internal-login`: Allows Adobe internal developers to create credentials for a sandbox environment
- `init-hello-world-action`: Initializes a basic Hello World action with all necessary files
## Example Commands
Here are some examples of how to use the MCP commands with AI assistants in Cursor:
```
# Initialize an App Builder project
mcp_app_builder_app_init
# Initialize a Hello World action
mcp_app_builder_init_hello_world_action --actionName my-hello-action
# List all actions in a package
mcp_app_builder_rt_action_list --packageName my-package
## License
Apache-2.0