README.md
API interface for Adobe Experience Platform integration
MCP API Services for Adobe Experience Platform
This Node.js server provides an API for integrating AI development and QA environments with Adobe Experience Platform (AEP), supporting key functions like schemas, datasets, segments, profiles, and beyond.
Future functionality
- Audience APIs
- AJO journey API
** credit to great work of Praveeen Sharma https://github.com/praveensharmajava/
Features
- Schema Management
- Dataset Operations
- Segment Management
- Data Ingestion
- Profile Management
- Query Service
- Destinations Management
- Swagger Documentation
- Input Validation
- Error Handling
Prerequisites
- Node.js (v14 or higher)
- npm or yarn
- Adobe Experience Platform account with API access
- Adobe Developer Console project with AEP integration
Setup
- Clone the repository:
git clone https://github.com/praveensharmajava/mcp-adobe-aep.git
cd mcp-adobe-aep
- Install dependencies:
npm install
- Create a
.envfile in the root directory with your Adobe credentials:
PORT=3000
AEP_BASE_URL=https://platform.adobe.io
AEP_CLIENT_ID=your_client_id
AEP_CLIENT_SECRET=your_client_secret
AEP_ORG_ID=your_organization_id
- Build the project:
npm run build
- Start the server:
npm start
For development:
npm run dev
API Documentation
Once the server is running, you can access the Swagger documentation at:
http://localhost:3000/api-docs
API Endpoints
Schemas
- GET /api/aep/schemas - List all schemas
- POST /api/aep/schemas - Create a new schema
Datasets
- GET /api/aep/datasets - List all datasets
- POST /api/aep/datasets - Create a new dataset
Segments
- GET /api/aep/segments - List all segments
- POST /api/aep/segments - Create a new segment
Data Ingestion
- POST /api/aep/ingest/:datasetId - Ingest data into a dataset
Profiles
- GET /api/aep/profiles/:identityValue - Get unified profile
Query Service
- POST /api/aep/query - Execute a query
Destinations
- GET /api/aep/destinations - List all destinations
- POST /api/aep/destinations/:destinationId/activate/:segmentId - Activate a segment
Error Handling
The server includes comprehensive error handling for:
- Adobe API errors
- Connection issues
- Validation errors
- Internal server errors
Development
To contribute to the project:
- Create a new branch
- Make your changes
- Write/update tests
- Submit a pull request
Testing
Run the test suite:
npm test
License
ISC
Tools (6)
list_schemasList all available schemas in AEPlist_datasetsList all available datasets in AEPlist_segmentsList all available segments in AEPingest_dataIngest data into a specific datasetget_profileGet a unified profile by identity valueexecute_queryExecute a query using the AEP Query ServiceEnvironment Variables
PORTPort for the server to run onAEP_BASE_URLrequiredBase URL for Adobe Experience Platform APIAEP_CLIENT_IDrequiredAdobe Developer Console Client IDAEP_CLIENT_SECRETrequiredAdobe Developer Console Client SecretAEP_ORG_IDrequiredAdobe Organization IDConfiguration
claude_desktop_config.json
{"mcpServers": {"aep": {"command": "node", "args": ["/path/to/mcp-adobe-aep/index.js"], "env": {"AEP_BASE_URL": "https://platform.adobe.io", "AEP_CLIENT_ID": "your_client_id", "AEP_CLIENT_SECRET": "your_client_secret", "AEP_ORG_ID": "your_organization_id"}}}}Try it
→List all the schemas currently defined in our Adobe Experience Platform instance.
→Retrieve the unified profile for the user with identity value 'user123'.
→Execute a query to find the total count of records in the customer dataset.
→List all available segments to see which audiences are ready for activation.