aem-mcp-server 1.0.0 → 1.0.2

package/README.md

@@ -10,23 +10,6 @@ This project is designed for AEM developers, content teams, and automation engin
 
 ---
 
-## Table of Contents
-
-- [Overview](#overview)
-- [Features](#features)
-- [Quick Start](#quick-start)
-- [Usage Examples](#usage-examples)
-- [Configuration](#configuration)
-- [API & Client Usage](#api--client-usage)
-- [AI IDE Integration (Cursor, Cline, etc.)](#ai-ide-integration-cursor-cline-etc)
-- [Security](#security)
-- [Project Structure](#project-structure)
-- [Integrations](#integrations)
-- [Contribution](#contribution)
-- [License](#license)
-
----
-
 ## Overview
 - **Modern, TypeScript-based AEM MCP server**
 - **REST/JSON-RPC API** for AEM content, component, and asset operations
@@ -44,7 +27,6 @@ This project is designed for AEM developers, content teams, and automation engin
 - **Template & Structure Discovery**: List templates, analyze page/component structure
 - **JCR Node Access**: Legacy and modern node/content access
 - **AI/LLM Integration**: Natural language interface for AEM via OpenAI, Anthropic, Ollama, or custom LLMs
-- **Telegram Bot**: Manage AEM via chat, including conversational commands
 - **Security**: Auth, environment-based config, and safe operation defaults
 
 ---
@@ -57,89 +39,16 @@ This project is designed for AEM developers, content teams, and automation engin
 
 ### Installation
 ```sh
-cd clone
-npm install
-```
-
-### Build
-```sh
-npm run build
-```
-
-### Run (Production)
-```sh
-npm start
-```
-
-### Run (Development, hot reload)
-```sh
-npm run dev
-```
-
----
-
-## Usage Examples
-
-### 1. List all pages under a path
-```sh
-curl -u admin:admin \
-  -X POST http://localhost:8080/api \
-  -H 'Content-Type: application/json' \
-  -d '{"method":"mcp_aem-mcp_listPages","params":{"siteRoot":"/content/we-retail","depth":2,"limit":10}}'
+npm install aem-mcp-server -g
 ```
 
-### 2. Update a component property
+### Start the Server
 ```sh
-curl -u admin:admin \
-  -X POST http://localhost:8080/api \
-  -H 'Content-Type: application/json' \
-  -d '{"method":"mcp_aem-mcp_updateComponent","params":{"componentPath":"/content/we-retail/us/en/experience/jcr:content/root/hero_image","properties":{"Heading":"New Heading"}}}'
-```
-
-### 3. Use with AI IDEs (Cursor, Cline, etc.)
-- See the [AI IDE Integration](#ai-ide-integration-cursor-cline-etc) section below.
-
----
-
-## Configuration
-
-### Environment Variables
-Create a `.env` file in the project root with the following (edit as needed):
-
-```
-AEM_HOST=http://localhost:4502
-AEM_SERVICE_USER=admin
-AEM_SERVICE_PASSWORD=admin
-SERVER_PORT=3000
-MCP_USERNAME=admin
-MCP_PASSWORD=admin
-```
-
-### MCP Client Configuration
-Sample for AI-based code editors or custom clients:
-
-```json
-{
-  "mcpServers": {
-    "aem-mcp": {
-      "command": "node",
-      "args": [
-        "absolute path to dist/index.js"
-      ]
-    }
-  }
-}
+aem-mcp
 ```
 
 ---
 
-## API & Client Usage
-- **REST/JSON-RPC**: Exposes all AEM operations via HTTP endpoints
-- **Supported Operations**: Page/asset CRUD, component validation/update, search, rollout, publish, text/image extraction, and more
-- **AI/LLM**: Send natural language commands to the server (via API or Telegram)
-
----
-
 ## AI IDE Integration (Cursor, Cline, etc.)
 
 AEM MCP Server is compatible with modern AI IDEs and code editors that support MCP protocol, such as **Cursor** and **Cline**.
@@ -150,40 +59,34 @@ AEM MCP Server is compatible with modern AI IDEs and code editors that support M
    - Open your IDE's MCP server settings.
    - Add a new server with:
      - **Type:** Custom MCP
-     - **Command:** `node`
-     - **Args:** `["/absolute/path/to/dist/index.js"]`
-     - **Port:** `3000` (or as configured)
-     - **Auth:** Use `MCP_USERNAME`/`MCP_PASSWORD` from your `.env`
+     - **url:** `http://127.0.0.1:3000/mcp`
+
 3. **Restart your IDE** and connect. The IDE will now be able to:
    - List, search, and manage AEM content
    - Run MCP methods (CRUD, search, rollout, etc.)
    - Use AI/LLM features if enabled
 
-### Custom MCP Clients
-- You can build your own MCP client in any language that supports HTTP/JSON-RPC.
-- See the [Usage Examples](#usage-examples) for API call patterns.
-- Authenticate using basic auth (`MCP_USERNAME`/`MCP_PASSWORD`).
-- All MCP methods are available via the `/api` endpoint.
-
----
-
-## Security
-- Auth required for all operations (see `MCP_USERNAME`/`MCP_PASSWORD`)
-- Environment-based configuration for safe deployment
-- All destructive operations require explicit parameters and validation
+Sample for AI-based code editors or custom clients:
 
----
+```json
+{
+  "mcpServers": {
+    "AEM": {
+      "url": "http://127.0.0.1:3000/mcp"
+    }
+  }
+}
+```
 
-## Project Structure
-- `src/` — TypeScript source code
-- `dist/` — Compiled JS output
+![cursor.png](docs/cursor.png)
 
----
+## Usage
 
-## Integrations
-- **AI/LLM**: OpenAI, Anthropic, Ollama, custom HTTP APIs
+@[TOOL_NAME]() params
 
----
+```
+@scanPageComponents() /content/path/to/page
+```
 
 ## Contribution
 Contributions are welcome! Please open issues or pull requests for bug fixes, features, or documentation improvements.

package/cli/cli.js

@@ -0,0 +1,21 @@
+const yargs = require('yargs');
+const { hideBin } = require('yargs/helpers');
+const { startServer } = require('../dist/index.js');
+
+const argv = yargs(hideBin(process.argv)).options({
+  host: { type: 'string', default: 'http://localhost:4502' },
+  user: { type: 'string', default: 'admin' },
+  pass: { type: 'string', default: 'admin' },
+  mcpPort: { type: 'number', default: 3000 },
+  explorer: { type: 'boolean', default: false },
+})
+  .help()
+  .alias('h', 'help')
+  .argv;
+
+if (argv.help) {
+  process.exit(0); // prevent startServer from running
+}
+
+const { host, user, pass, mcpPort, explorer } = argv;
+startServer({ host, user, pass, mcpPort, explorer });

package/dist/aem/aem.config.js

@@ -1,49 +1,86 @@
-// eslint-disable-next-line @typescript-eslint/triple-slash-reference
-/// <reference types="node" />
-export const DEFAULT_AEM_CONFIG = {
-    contentPaths: {
-        sitesRoot: process.env.AEM_SITES_ROOT || '/content',
-        assetsRoot: process.env.AEM_ASSETS_ROOT || '/content/dam',
-        templatesRoot: process.env.AEM_TEMPLATES_ROOT || '/conf',
-        experienceFragmentsRoot: process.env.AEM_XF_ROOT || '/content/experience-fragments',
-    },
-    replication: {
-        publisherUrls: process.env.AEM_PUBLISHER_URLS?.split(',') || ['http://localhost:4503'],
-        defaultReplicationAgent: process.env.AEM_DEFAULT_AGENT || 'publish',
-    },
-    components: {
-        allowedTypes: process.env.AEM_ALLOWED_COMPONENTS?.split(',') || [
-            'text', 'image', 'hero', 'button', 'list', 'teaser', 'carousel'
-        ],
-        defaultProperties: {
-            'jcr:primaryType': 'nt:unstructured',
-            'sling:resourceType': 'foundation/components/text'
-        },
-    },
-    queries: {
-        maxLimit: parseInt(process.env.AEM_QUERY_MAX_LIMIT || '100'),
-        defaultLimit: parseInt(process.env.AEM_QUERY_DEFAULT_LIMIT || '20'),
-        timeoutMs: parseInt(process.env.AEM_QUERY_TIMEOUT || '30000'),
-    },
-    validation: {
-        maxDepth: parseInt(process.env.AEM_MAX_DEPTH || '5'),
-        allowedLocales: ['en'],
-    },
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-export function getAEMConfig() {
-    return DEFAULT_AEM_CONFIG;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var aem_config_exports = {};
+__export(aem_config_exports, {
+  DEFAULT_AEM_CONFIG: () => DEFAULT_AEM_CONFIG,
+  getAEMConfig: () => getAEMConfig,
+  isValidComponentType: () => isValidComponentType,
+  isValidContentPath: () => isValidContentPath,
+  isValidLocale: () => isValidLocale
+});
+module.exports = __toCommonJS(aem_config_exports);
+const DEFAULT_AEM_CONFIG = {
+  contentPaths: {
+    sitesRoot: process.env.AEM_SITES_ROOT || "/content",
+    assetsRoot: process.env.AEM_ASSETS_ROOT || "/content/dam",
+    templatesRoot: process.env.AEM_TEMPLATES_ROOT || "/conf",
+    experienceFragmentsRoot: process.env.AEM_XF_ROOT || "/content/experience-fragments"
+  },
+  replication: {
+    publisherUrls: process.env.AEM_PUBLISHER_URLS?.split(",") || ["http://localhost:4503"],
+    defaultReplicationAgent: process.env.AEM_DEFAULT_AGENT || "publish"
+  },
+  components: {
+    allowedTypes: process.env.AEM_ALLOWED_COMPONENTS?.split(",") || [
+      "text",
+      "image",
+      "hero",
+      "button",
+      "list",
+      "teaser",
+      "carousel"
+    ],
+    defaultProperties: {
+      "jcr:primaryType": "nt:unstructured",
+      "sling:resourceType": "foundation/components/text"
+    }
+  },
+  queries: {
+    maxLimit: parseInt(process.env.AEM_QUERY_MAX_LIMIT || "100"),
+    defaultLimit: parseInt(process.env.AEM_QUERY_DEFAULT_LIMIT || "20"),
+    timeoutMs: parseInt(process.env.AEM_QUERY_TIMEOUT || "30000")
+  },
+  validation: {
+    maxDepth: parseInt(process.env.AEM_MAX_DEPTH || "5"),
+    allowedLocales: ["en"]
+  }
+};
+function getAEMConfig() {
+  return DEFAULT_AEM_CONFIG;
 }
-export function isValidContentPath(path, config = DEFAULT_AEM_CONFIG) {
-    const allowedRoots = Object.values(config.contentPaths);
-    return allowedRoots.some(root => path.startsWith(root));
+function isValidContentPath(path, config = DEFAULT_AEM_CONFIG) {
+  const allowedRoots = Object.values(config.contentPaths);
+  return allowedRoots.some((root) => path.startsWith(root));
 }
-export function isValidComponentType(componentType, config = DEFAULT_AEM_CONFIG) {
-    return config.components.allowedTypes.includes(componentType);
+function isValidComponentType(componentType, config = DEFAULT_AEM_CONFIG) {
+  return config.components.allowedTypes.includes(componentType);
 }
-export function isValidLocale(locale, config = DEFAULT_AEM_CONFIG) {
-    if (!locale)
-        return false;
-    const normalized = locale.toLowerCase();
-    return config.validation.allowedLocales.some(l => l.toLowerCase() === normalized ||
-        (normalized === 'en' && l.toLowerCase().startsWith('en')));
+function isValidLocale(locale, config = DEFAULT_AEM_CONFIG) {
+  if (!locale) return false;
+  const normalized = locale.toLowerCase();
+  return config.validation.allowedLocales.some((l) => l.toLowerCase() === normalized || normalized === "en" && l.toLowerCase().startsWith("en"));
 }
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_AEM_CONFIG,
+  getAEMConfig,
+  isValidComponentType,
+  isValidContentPath,
+  isValidLocale
+});