Socket
Book a DemoInstallSign in
Socket

@adobe-commerce/commerce-extensibility-tools

Package Overview
Dependencies
Maintainers
5
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@adobe-commerce/commerce-extensibility-tools

MCP server providing Temp Commerce Extensibility Tooling for deployment and management

1.1.0
latest
npmnpm
Version published
Maintainers
5
Created
Source

Adobe Commerce Extensibility Tools

A Model Context Protocol (MCP) server that provides Adobe I/O CLI tools for deployment and management of Adobe Developer App Builder applications, specifically designed for Adobe Commerce extensibility development.

🚀 Quick Start

1. Install the MCP Server

# Clone the repository
git clone <repository-url>
cd commerce-extensibility-tools

# Install dependencies
npm install

# Install globally for Cursor integration
npm install -g .

2. Configure Cursor IDE

Option A: One-Click Installation (Recommended) Install MCP Server

Option B: Manual Configuration Create or update your .cursor/mcp.json file:

{
  "mcpServers": {
    "adobe-io-tools": {
      "command": "commerce-extensibility-tools-mcp-server"
    }
  }
}

Option C: Manual Configuration with Environment Variables If you need to configure environment variables (e.g., for the documentation search tool), create or update your .cursor/mcp.json file:

{
  "mcpServers": {
    "adobe-io-tools": {
      "command": "commerce-extensibility-tools-mcp-server",
      "env": {
        "CLOUDFLARE_WORKER_URL": "https://your-custom-worker.workers.dev"
      }
    }
  }
}

Note: The CLOUDFLARE_WORKER_URL environment variable is optional. If not set, the documentation search tool will use the default worker URL: https://commerce-documentation-rag-service.apimesh-adobe-test.workers.dev

3. Restart Cursor

After configuration, restart Cursor IDE to load the new MCP server.

4. Verify Installation

# Check if the command is available
which commerce-extensibility-tools-mcp-server

# Test the server directly
commerce-extensibility-tools-mcp-server

Overview

This MCP server enables integration with Adobe I/O CLI tools through Cursor IDE, specifically designed for Adobe Commerce extensibility development. It provides:

  • Enhanced Schema Validation: Zod-based input validation with SDK-aware schema management
  • Commerce-Specific Tools: Event-driven integration patterns for Adobe Commerce PaaS and SaaS
  • Real-time Documentation: Intelligent search through Commerce App Builder documentation
  • Production-Ready Deployment: Comprehensive deployment and testing workflows
  • AI Assistant Integration: Extensive Cursor IDE rules for Adobe Commerce development with mandatory phase control

Features

Available Tools

Core Adobe I/O Tools

  • aio-app-deploy: Deploy Adobe I/O applications to runtime with comprehensive validation
  • aio-app-dev: Start local development server for Adobe I/O applications
  • aio-dev-invoke: Invoke runtime actions running locally via aio app dev
  • aio-login: Authenticate with Adobe I/O services
  • aio-where: Show current Adobe I/O configuration
  • aio-app-use: Configure runtime namespace
  • aio-configure-global: Manage global Adobe I/O configuration

Commerce Integration Tools

  • onboard: Configure Adobe I/O event providers and Commerce Events module
  • commerce-event-subscribe: Subscribe to Commerce events for product and customer changes

Documentation & Research

  • search-commerce-app-builder-docs: Search Commerce App Builder Extension documentation for coding guidance and implementation details

Advanced Features

Enhanced Schema Validation

  • Zod Integration: Type-safe input validation using Zod schemas
  • SDK-Aware Management: Automatic schema loading and validation
  • Default Value Application: Intelligent default value handling
  • Error Reporting: Detailed validation error messages

Commerce-Specific Capabilities

  • Event-Driven Patterns: Support for Adobe Commerce event subscriptions
  • PaaS/SaaS Compatibility: Works with both Adobe Commerce PaaS and SaaS offerings
  • Out-of-Process Extensibility: Designed for modern Commerce extensibility patterns

AI Assistant Integration

  • Cursor IDE Rules: Comprehensive rules for Adobe Commerce development
  • Development Workflow: Structured 4-phase development process with mandatory stopping points
  • Requirements Management: Automatic REQUIREMENTS.md generation and management
  • Security by Design: Built-in security and coding standards
  • Phase Control: MANDATORY user confirmation required after each phase

Supported Actions

  • List and select organizations, projects, and workspaces
  • Deploy applications with various options (skip build, force deploy, etc.)
  • Start local development servers for testing
  • Invoke runtime actions running locally
  • Handle authentication flows
  • Manage Adobe Commerce event configurations
  • Configure Adobe I/O event providers and Commerce Events module
  • Create event registrations and metadata for Commerce integrations
  • Search Commerce App Builder Extension documentation for coding guidance and implementation details

Development Workflow

  • Start Development Server: Use aio-app-dev to start local development
  • Test Actions: Use aio-dev-invoke to call runtime actions locally
  • Deploy: Use aio-app-deploy to deploy to production
  • Configure Events: Use onboard to set up event providers and Commerce integration
  • Monitor: Use aio-where and other tools to manage configuration

📋 Detailed Installation

Prerequisites

  • Node.js 18.0.0 or higher
  • Adobe I/O CLI (aio) installed globally
  • Cursor IDE (for MCP integration)

Environment Setup

  • Install Adobe I/O CLI:
npm install -g @adobe/aio-cli

Testing and Debugging

Using the MCP Inspector

The MCP Inspector is an interactive developer tool for testing and debugging MCP servers. You can use it to:

  • Test all available tools with custom inputs
  • Inspect tool schemas and descriptions
  • Monitor server logs and notifications
  • Debug connectivity issues

Quick Start

# Run the inspector with your server
npm test

Manual Inspector Usage

# Direct inspector command
npx @modelcontextprotocol/inspector node index.js

# With custom arguments
npx @modelcontextprotocol/inspector node index.js --verbose

Inspector Features

  • Tools Tab: Test all Adobe I/O tools with custom parameters
  • Notifications Pane: Monitor server logs and debug messages
  • Server Connection: Verify basic connectivity and capability negotiation

Development Workflow

  • Start Inspector: npm test
  • Test Tools: Use the Tools tab to test each Adobe I/O tool
  • Monitor Logs: Watch the Notifications pane for server messages
  • Iterate: Make changes to your server and reconnect to test

For more information about the MCP Inspector, visit: MCP Inspector Documentation

Configuration

Prerequisites

  • Node.js 18.0.0 or higher
  • Adobe I/O CLI (aio) installed globally
  • Valid Adobe Developer Console project
  • Cursor IDE (for MCP integration)

Environment Setup

  • Install Adobe I/O CLI:
npm install -g @adobe/aio-cli
  • Configure your Adobe I/O project:
aio login
aio console ws select

Usage

With Cursor IDE

  • Configure the MCP server (see Quick Start section above)
  • Restart Cursor to load the new MCP server
  • Access tools through Cursor's MCP interface:
    • Use / to access MCP tools
    • Select "adobe-io-tools" from the available servers
    • Choose from available Adobe I/O tools

Quick Commands in Cursor

Once configured, you can use these tools directly in Cursor:

  • Deploy your app: /aio-app-deploy - Deploy your Adobe I/O application
  • Start development: /aio-app-dev - Start local development server
  • Authenticate: /aio-login - Authenticate with Adobe I/O
  • Check config: /aio-where - Check current configuration
  • Setup events: /onboard - Configure event providers
  • Invoke actions: /aio-dev-invoke - Test runtime actions locally
  • Search docs: /search-commerce-app-builder-docs - Search Commerce App Builder documentation

Command Line

For development and testing:

# Start the server directly
node index.js

# Or use npm
npm start

# Test with MCP Inspector
npm test

📚 Documentation Search Tool

The search-commerce-app-builder-docs tool provides intelligent search capabilities for Commerce App Builder Extension documentation, helping developers find relevant information for coding decisions and implementation details.

Features

  • Semantic Search: Uses advanced search algorithms to find the most relevant documentation
  • Rich Results: Returns documentation with metadata, source URLs, and content previews
  • Configurable Results: Control the number of results returned (default: 5, max: configurable)
  • Cloudflare Integration: Uses Cloudflare Workers for fast, reliable document retrieval

Usage Examples

# Search for general App Builder information
/search-commerce-app-builder-docs "What is App Builder?"
# Search for specific implementation details
/search-commerce-app-builder-docs "How to create custom actions in App Builder?"
# Search for configuration and setup information
/search-commerce-app-builder-docs "How to configure authentication in App Builder?"

Tool Parameters

  • query (required): The search query for Commerce App Builder Extension documentation
  • maxResults (optional): Maximum number of results to return (defaults to 5)

Environment Configuration

The tool uses the following environment variables:

  • CLOUDFLARE_WORKER_URL: URL of the Cloudflare Worker for document retrieval
    • Default: https://commerce-documentation-rag-service.apimesh-adobe-test.workers.dev

Example Response

{
  "success": true,
  "query": "What is App Builder?",
  "resultsCount": 3,
  "documents": [
    {
      "rank": 1,
      "source": "src/pages/intro_and_overview/faq.md",
      "content": "App Builder is a complete design, application, and runtime framework...",
      "contentPreview": "App Builder is a complete design, application, and runtime framework...",
      "metadata": {
        "repository": "https://github.com/AdobeDocs/app-builder",
        "source": "src/pages/intro_and_overview/faq.md"
      }
    }
  ],
  "timestamp": "2025-08-21T13:12:19.214Z"
}

Use Cases

  • Development Guidance: Find relevant documentation for coding decisions
  • Best Practices: Search for implementation best practices and patterns
  • API Reference: Look up specific API documentation and usage examples
  • Troubleshooting: Find solutions for common issues and error messages
  • Architecture Decisions: Research architectural patterns and design principles

🔧 Troubleshooting

Installation Issues

MCP Server Not Found

# Check if the command is available
which commerce-extensibility-tools-mcp-server

# If not found, reinstall globally
npm install -g .

# Verify the bin field in package.json
cat package.json | grep -A 5 '"bin"'

Permission Errors

# Make sure the index.js file has execute permissions
chmod +x index.js

# Check if npm global bin is in your PATH
npm config get prefix
echo $PATH

Cursor Not Recognizing Server

  • Restart Cursor after configuration changes
  • Check that .cursor/mcp.json is properly formatted
  • Verify the command path in the configuration

Common Issues

  • Authentication Errors: Ensure you're logged in with aio login
  • Configuration Issues: Use aio where to check current configuration
  • Deployment Failures: Verify your Adobe I/O project is properly configured
  • Onboarding Issues: Check environment variables and workspace.json for event configuration

Cursor-Specific Issues

  • MCP Server Not Found: Ensure the server is installed globally or linked
  • Command Not Found: Check that the bin field is properly configured in package.json
  • Permission Errors: Make sure the index.js file has execute permissions
  • Cursor Not Recognizing Server: Restart Cursor after configuration changes

Verifying Installation

To verify the MCP server is properly installed:

# Check if the command is available
which commerce-extensibility-tools-mcp-server

# Test the server directly
commerce-extensibility-tools-mcp-server

Debug Mode

Enable verbose output for debugging:

# Set verbose flag when calling tools
# The server will show detailed command execution

Development

Project Structure

commerce-extensibility-tools/
├── index.js                    # Main entry point
├── package.json                # Dependencies and scripts
├── LICENSE                     # Apache 2.0 License
├── README.md                   # This file
├── .github/
│   └── workflows/
│       └── publish.yml         # NPM publishing workflow
├── rules/                      # AI Assistant Rules
│   ├── Cursor/                 # Cursor IDE rules for Adobe Commerce
│   │   ├── README.md           # Rules documentation
│   │   ├── main-orchestrator.mdc
│   │   ├── adobe-commerce-basics.mdc
│   │   ├── app-builder-technical-guide.mdc
│   │   ├── commerce-scope-guardrails.mdc
│   │   ├── deployment-and-cleanup.mdc
│   │   ├── developer-tools-integration.mdc
│   │   ├── development-workflow.mdc
│   │   ├── dos-and-donts.mdc
│   │   ├── events-and-webhooks-guide.mdc
│   │   ├── phase-control.mdc   # NEW: Mandatory phase control protocol
│   │   ├── requirements-documentation.mdc
│   │   └── security-and-coding-standards.mdc
│   ├── Claude/                 # Claude AI assistant rules
│   ├── Copilot/                # GitHub Copilot rules
│   └── Gemini/                 # Google Gemini rules
└── src/
    ├── server.js               # MCP server implementation
    ├── tools/                  # Tool implementations
    │   ├── index.js            # Tool registry
    │   ├── aio-app-deploy.js
    │   ├── aio-app-dev.js
    │   ├── aio-dev-invoke.js
    │   ├── aio-login.js
    │   ├── aio-where.js
    │   ├── aio-app-use.js
    │   ├── aio-configure-global.js
    │   ├── onboard.js
    │   ├── commerce-event-subscribe.js
    │   └── search-commerce-app-builder-docs.js
    ├── schemas/                # JSON schema definitions
    │   ├── aio-app-deploy.json
    │   ├── aio-app-dev.json
    │   ├── aio-login.json
    │   ├── aio-where.json
    │   ├── aio-app-use.json
    │   ├── aio-dev-invoke.json
    │   ├── aio-configure-global.json
    │   ├── onboard.json
    │   ├── commerce-event-subscribe.json
    │   └── search-commerce-app-builder-docs.json
    └── utils/                  # Utility functions
        ├── sdk-schema-manager.js  # SDK-aware schema management with Zod
        ├── command-executor.js
        └── project-validator.js

Adding New Tools

  • Create a new tool file in src/tools/
  • Create a corresponding JSON schema file in src/schemas/
  • Export a default async function that handles the tool logic
  • Add the tool to the registry in src/tools/index.js

Example Tool Implementation

import { executeCommand } from '../utils/command-executor.js';

export default async function handleMyTool(args) {
  const { param1, param2 } = args;
  
  const command = 'my-command';
  const cmdArgs = [param1, param2];
  
  const result = await executeCommand(command, cmdArgs);
  
  if (result.success) {
    return {
      content: [
        {
          type: 'text',
          text: `✅ Success: ${result.output}`
        }
      ]
    };
  } else {
    return {
      content: [
        {
          type: 'text',
          text: `❌ Error: ${result.error}`
        }
      ]
    };
  }
}

Example Schema Definition

{
  "name": "my-tool",
  "description": "Description of what this tool does",
  "inputSchema": {
    "type": "object",
    "properties": {
      "param1": {
        "type": "string",
        "description": "Description of parameter 1"
      },
      "param2": {
        "type": "boolean",
        "description": "Description of parameter 2",
        "default": false
      }
    },
    "required": ["param1"]
  }
}

AI Assistant Integration

This project includes comprehensive AI assistant rules for Adobe Commerce development:

Cursor IDE Rules

Located in rules/Cursor/, these rules transform the AI assistant into an Adobe Commerce Solutions Architect with:

  • Expert Persona: Deep understanding of PaaS vs SaaS architectural differences
  • Structured Development: 4-phase development process with mandatory stopping points
  • Security by Design: Comprehensive security principles and best practices
  • Event-Driven Patterns: Commerce event registration and subscription workflows
  • MCP Tools Integration: Seamless integration with Adobe I/O MCP Server tools
  • Phase Control: MANDATORY user confirmation required after each phase

Phase Control Protocol

The AI assistant now enforces mandatory stopping points between development phases:

  • Phase 1 → Phase 2 (Requirements → Architecture): Agent stops after gathering requirements and waits for user confirmation
  • Phase 2 → Phase 3 (Architecture → Code Generation): Agent stops after presenting architectural plan and waits for explicit user approval
  • Phase 3 → Phase 4 (Code Generation → Documentation): Agent stops after code generation and asks if user wants documentation

Required confirmation messages:

  • After Phase 1: "I have gathered the requirements and created/updated the REQUIREMENTS.md file. Please review the requirements I've documented. Should I proceed to create the architectural plan? I will wait for your confirmation before moving to Phase 2."
  • After Phase 2: "Please review this architectural plan. Do you approve this approach? I will wait for your explicit confirmation before generating any code."

Installation

  • Copy the rules/Cursor/ directory to your project's .cursor/rules/ directory
  • The rules will automatically be applied when working with Adobe Commerce extensions

Usage

When you request Adobe Commerce extension development, the AI will:

  • Check for existing requirements or create a REQUIREMENTS.md file
  • Gather requirements through clarifying questions
  • STOP and wait for your confirmation before proceeding to architectural planning
  • Present an architectural plan for your approval
  • STOP and wait for your explicit approval before generating any code
  • Generate App Builder-based extension code after approval
  • Provide comprehensive documentation and implementation guides

Support

For issues related to:

Contributing

Contributions are welcomed! Please read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache License, Version 2.0. See LICENSE for more information.

Version: 1.0.0
Last Updated: December 2024
Compatibility: Adobe Commerce PaaS & SaaS, App Builder Framework, Node.js 18+

Keywords

mcp

FAQs

Package last updated on 01 Sep 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.