Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 41 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

[![CI](https://github.com/cloudadoption/helix-mcp/actions/workflows/main.yml/badge.svg)](https://github.com/cloudadoption/helix-mcp/actions/workflows/main.yml)

An MCP (Model Context Protocol) server that provides tools to enable developers and administators of sites deployed with AEM Edge Delivery Services and Document Authoring.
An MCP (Model Context Protocol) server that provides admin tools for sites deployed with AEM Edge Delivery Services and Document Authoring.

> **Note:** Developer-focused tools (docs search, block collection) have moved to [adobe/skills](https://github.com/adobe/skills) and are no longer part of this server.

## Features

Expand All @@ -13,9 +15,6 @@ An MCP (Model Context Protocol) server that provides tools to enable developers
- **check-bulk-status** - Checks the status of a bulk page status job and retrieves results for all pages including their publishing and preview status.
- **audit-log** - Retrieves detailed audit logs from the AEM Edge Delivery Services repository showing user activities, system operations, and performance metrics.
- **rum-data** - Queries Core Web Vitals and engagement metrics for sites or pages using operational telemetry data with various aggregation types.
- **aem-docs-search** - Searches the AEM documentation at www.aem.live for specific topics, features, or guidance.
- **block-list** - Retrieve the list of blocks in the AEM Block Collection
- **block-details** - Retrieve the details for the implementation of a specific block in the AEM Block Collection

### Prompts

Expand All @@ -31,7 +30,27 @@ This project uses ESLint for code quality and consistency. The linting configura

## Usage

### Cursor AI setup
### Remote Server (Hosted)

The server is available as a hosted Cloudflare Worker with Streamable HTTP transport. Configure your MCP client to connect using the remote URL with an `Authorization` header:

```json
"helix-mcp-server": {
"type": "streamableHttp",
"url": "https://helix-mcp.cloudadoption.workers.dev/mcp",
"headers": {
"Authorization": "Bearer your_api_token_here"
}
}
```

> **Note:** The rum-data tool may have limited functionality when running on the hosted server due to `@adobe/rum-distiller` compatibility with Cloudflare Workers.

### Local (npx via stdio)

For local usage, you can run the server directly via `npx` with the token provided as an environment variable.

#### Cursor AI setup

[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=helix-mcp-server&config=eyJjb21tYW5kIjoibnB4IGh0dHBzOi8vZ2l0aHViLmNvbS9jbG91ZGFkb3B0aW9uL2hlbGl4LW1jcCIsImVudiI6eyJIRUxJWF9BRE1JTl9BUElfVE9LRU4iOiJ5b3VyX2FwaV90b2tlbl9oZXJlIiwiUlVNX0RPTUFJTl9LRVkiOiJ5b3VyX3J1bV9kb21haW5fa2V5In19)

Expand All @@ -50,7 +69,7 @@ To use this MCP server with Cursor AI, go to `Cursor Settings`, `MCP` and a `New
}
```

### VS Code with GitHub Copilot setup
#### VS Code with GitHub Copilot setup

To use this MCP server with VS Code and GitHub Copilot:

Expand Down Expand Up @@ -83,6 +102,22 @@ To use this MCP server with VS Code and GitHub Copilot:

**Note**: Replace `your_api_token_here` with your actual API tokens. You can obtain the Helix admin token by following these instructions: [https://www.aem.live/docs/admin-apikeys](https://www.aem.live/docs/admin-apikeys) OR by logging into [admin.hlx.page/login](https://admin.hlx.page/login) and capturing the `auth_token` from the cookie.

## Deployment

The server deploys as a Cloudflare Worker.

```bash
npm run deploy # default environment
npm run deploy:staging # staging
npm run deploy:production # production
```

For local development with the worker:

```bash
npm run dev:worker
```

## Contributing

1. Fork the repository
Expand Down
Loading