Webasyst

You run the Webasyst MCP Server to manage apps, plugins, themes, and configuration via an AI-assisted interface. It provides a centralized, local development server that streamlines creating and configuring Webasyst components.

How to use

You connect an MCP client (such as Claude Desktop) to the Webasyst MCP Server to access a range of development tools. Use natural language commands to list apps, inspect details, create structures for apps/plugins/themes, manage routing and configurations, and automate common development tasks. The server exposes a set of endpoints you call through the MCP client, enabling you to perform actions without manually editing files.

How to install

Prerequisites: ensure you have Node.js version 18 or newer installed on your machine. You also need a Webasyst project structure if you plan to run the server against a real Webasyst setup.

Install using npm (recommended)

npm install -g webasyst-mcp-server

Install from source

If you prefer to install from the source repository, follow these steps to clone the project, install dependencies, and prepare the executable script.

From source steps

git clone https://github.com/emmy-design/webasyst-mcp.git
cd webasyst-mcp

npm install

Make executable and run

chmod +x webasyst-mcp.js

npm start

Claude Desktop integration

To connect Claude Desktop to the MCP server, add the following configuration snippet. This defines a local stdio MCP server that launches the Webasyst MCP script.

{
  "mcpServers": {
    "webasyst": {
      "command": "node",
      "args": ["/путь/к/вашему/проекту/webasyst-mCP/webasyst-mCP.js"],
      "env": {}
    }
  }
}

Configuration overview

The MCP server provides access to several areas of Webasyst development through a consistent interface. You can manage the following: apps, plugins, themes, routing, and system configurations. Commands are issued via the MCP client, and you can automate repetitive tasks through scripted work patterns.

Note about tooling and commands

The server exposes a suite of tools that you can invoke through the MCP client, including listing apps, retrieving app info, creating structures for new apps/plugins/themes, enabling UI components, setting up SEO/analytics workflows, and generating deployment assets. Use the exact tool names and parameters as shown in the client’s guidance to perform each action.

Troubleshooting and tips

If you encounter permission or path issues, ensure the script path in the Claude Desktop configuration is correct and that you have read/write access to the project directory. Verify Node.js is installed and that you started the server from a directory that contains your Webasyst project structure.

Security and local changes

All changes performed through the MCP server are intended to be local to your development environment. Maintain version control for generated structures to track changes and enable safe collaboration.

Examples of supported actions

You can perform tasks such as listing apps, viewing app details, listing and inspecting plugins, exploring themes, retrieving routing and system configurations, and running the Webasyst CLI for administrative tasks.

Project structure and requirements

Typical project setup includes the Webasyst framework in your project directory and a running MCP server that can access and modify that setup through the defined commands. Ensure your environment has the necessary permissions to read and write within the project directory.

Additional notes

The server is designed to work with Webasyst development workflows and supports automation through structured commands. It is intended to speed up app/plugin/theme development, routing configuration, and deployment preparation.

Examples of typical usage phrases

Show me all Webasyst apps Create a new app with ID "myapp" and name "My App" Show information about app "shop" Create a plugin "analytics" for app "shop" with name "Sales Analytics"

Notes on UI and localization

The MCP workflow emphasizes compatibility with Webasyst UI 2.0 components and localization rules. Use UI guidelines when designing new interfaces or dashboards that will be managed through the MCP server.

DevOps and deployment

Prepare deployment assets such as Nginx/VHost or .htaccess configurations if you plan to move the setup to a staging or production environment. Scripted tools within the MCP server can help generate these artifacts.

Authors and licenses

This MCP server is provided under the MIT license for open development and collaboration.

Available tools

list_webasyst_apps

Return the list of all Webasyst applications (including system apps).

get_app_info

Fetch detailed information about a specific app using its app_id.

list_app_plugins

List all plugins for a given app and retrieve plugin info with get_plugin_info.

get_plugin_info

Provide detailed information about a specific plugin (app_id + plugin_id).

list_app_themes

List available themes for an application.

list_app_widgets

List widgets for a given app.

get_routing_config

Retrieve routing configuration for an app, optionally for a specific app_id.

get_system_config

Fetch the system-wide configuration settings.

run_webasyst_cli

Execute the Webasyst CLI command (cli.php) with provided command and arguments.

create_app_structure

Create the basic directory structure for a new app.

create_plugin_structure

Create the basic directory structure for a new plugin.

create_action

Add a new action definition into the dashboard for an app.

create_model

Create a data model scaffold for an app.

create_theme

Create a new theme scaffold for an app.

create_widget

Create a new widget in the dashboard for an app.

create_generic_app

Create a generic app at a specified path.

create_site_plugin

Create a site plugin for a given app.

create_site_widget

Create a site widget for a given app.

create_site_block

Create a site block for a given app.

create_site_theme

Create a site theme for a given app.

create_shop_plugin

Create a shop plugin for the shopping module.

create_shop_theme

Create a shop theme for the shopping module.

create_shop_report

Create a shop report template.

create_shipping_plugin

Create a shipping plugin under wa-plugins/shipping.

create_payment_plugin

Create a payment plugin under wa-plugins/payment.

enable_webasyst_ui

Enable Webasyst UI 2.0 integration for an application.

create_ui_component

Create a UI component such as a table, form, or modal.

setup_seo_optimization

Configure SEO optimization settings for a project.

analyze_project

Analyze the project for potential improvements and compliance.

generate_po_template

Generate a PO template for localization workflows.

compile_mo

Compile MO localization files from PO templates.

check_project_compliance

Check project against localization and coding standards.

prepare_release_bundle

Prepare a release bundle with all assets for deployment.

generate_nginx_vhost

Generate Nginx virtual host configuration for the project.

generate_htaccess

Generate .htaccess rules for routing and security.