degree-dynamicweb-mcp

MCP-сервер (Model Context Protocol) для DynamicWeb 10 Admin API. Дает Claude Code полный доступ к управлению типами элементов, полями, страницами, параграфами и обнаружению API DynamicWeb — без обращения к интерфейсу DW Admin.

Инструменты

Типы элементов

Обслуживание схемы

Развертывание XML типа элемента не затрагивает базу данных. Пока схема не синхронизирована, поле, для которого отсутствует колонка, сохраняется без ошибки и ничего не хранит.

После развертывания нового XML: dw_itemtype_sync_schema, затем dw_itemtype_health. Конечная точка синхронизации отвечает «ok», даже если она прервалась на полпути, поэтому именно проверка здоровья показывает, сработало ли это, — а /Files/System/Log/items/ActivationWorkflow содержит настоящие ошибки. Тип элемента, у которого таблица отсутствует полностью, вообще не появляется в отчете о здоровье.

Поля

Страницы

Параграфы

dw_page_set_fields и dw_paragraph_set_fields проверяют собственную запись. Имя поля, отсутствующее в объявлениях типа элемента, вызывает ошибку, в которой перечисляются существующие имена, и после сохранения они читают элемент обратно и возвращают то, что он теперь содержит. DW отвечает «ok» независимо от того, было ли сохранено значение, поэтому опечатка в SystemName раньше была неотличима от успешной записи.

Товары

dw_product_update принимает три входные карты:

• fields — поля товара верхнего уровня (Name, DefaultPrice, Stock и т.д.)

• customFields — значения глобальных пользовательских полей товара, ключ — SystemName

• categoryFields — значения полей категории товара, ключ — SystemName

Схема товаров

Управляйте моделью данных PIM: категории товаров (группы атрибутов) и поля товаров (сами атрибуты).

Файлы

Delivery API (только чтение)

Обнаружение API

Related MCP server: TeamDesk MCP Server

Настройка

1. Получите токен DW API

В DynamicWeb Admin перейдите в Settings > Developer > API Keys и создайте новый ключ с полным доступом.

2. Настройте ваш ИИ-клиент

Добавьте в .mcp.json вашего проекта:

{
  "mcpServers": {
    "dynamicweb": {
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Отредактируйте ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) или %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "dynamicweb": {
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Добавьте в ~/.cursor/mcp.json (глобально) или .cursor/mcp.json (для проекта):

{
  "mcpServers": {
    "dynamicweb": {
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Добавьте .vscode/mcp.json в ваш проект (обратите внимание: используется servers, а не mcpServers):

{
  "servers": {
    "dynamicweb": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Отредактируйте ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "dynamicweb": {
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Настройте через интерфейс MCP-настроек Cline или добавьте в его конфигурацию:

{
  "mcpServers": {
    "dynamicweb": {
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Добавьте в settings.json Zed (обратите внимание: используется context_servers):

{
  "context_servers": {
    "dynamicweb": {
      "source": "custom",
      "command": "npx",
      "args": ["-y", "@degree-as/dynamicweb-mcp"],
      "env": {
        "DW_BASE_URL": "https://your-dw-instance",
        "DW_API_TOKEN": "your-token"
      }
    }
  }
}

Добавьте в ~/.continue/config.yaml:

mcpServers:
  - name: dynamicweb
    command: npx
    args:
      - -y
      - "@degree-as/dynamicweb-mcp"
    env:
      DW_BASE_URL: https://your-dw-instance
      DW_API_TOKEN: your-token

3. Перезапустите ваш клиент

MCP-сервер запускается автоматически при загрузке вашего ИИ-клиента.

Локальная разработка

Если вы хотите запускать из исходного кода вместо опубликованного пакета:

git clone https://github.com/Degree-AS/degree-dynamicweb-mcp.git
cd degree-dynamicweb-mcp
npm install
npm run build

Затем используйте "command": "node", "args": ["/path/to/degree-dynamicweb-mcp/dist/index.js"] в .mcp.json.

Псевдонимы типов полей

Поля типов элементов (dw_field_save, dw_itemtype_create)

При создании полей можно использовать короткие псевдонимы вместо полных имен классов .NET:

Любое полное имя класса редактора .NET также принимается. Используйте dw_field_types, чтобы узнать все доступные редакторы из вашего экземпляра DW.

Повторяемые списки (itemrelation)

itemrelation (ItemRelationListEditor) создает повторяемый список дочерних элементов — универсальный способ моделировать элементы FAQ, строки, персоны и т.д. (вместо фиксированных нумерованных слотов, таких как Question1..5). Требует два дополнительных параметра:

Сначала создайте дочерний тип элемента, затем родительский:

// 1) child row
dw_itemtype_create { systemName: "OpeningHoursRow", fields: [
  { name: "Label", systemName: "Label", type: "text" },
  { name: "Value", systemName: "Value", type: "text" },
]}
// 2) parent with the repeatable list
dw_itemtype_create { systemName: "OpeningHours", fields: [
  { name: "Title", systemName: "Title", type: "text" },
  { name: "Rows",  systemName: "Rows",  type: "itemrelation", itemRelationType: "OpeningHoursRow" },
]}

Инструмент автоматически генерирует необходимые EditorConfiguration + EditorFields (тип элемента / источник элемента) и базовый тип Int32.

Поля продукта (dw_product_field_save)

Поля продукта используют другую систему — целочисленный TypeId из FieldTypeAll, а не имена классов редактора:

Числовой TypeId также принимается напрямую. Используйте dw_product_field_type_list, чтобы получить актуальный список из вашего экземпляра DW.

Архитектура

src/
  index.ts          Entry point - reads config from env, registers tools
  client.ts         DwClient - HTTP client for Admin API, Update API, Delivery API
  utils.ts          Shared Zod helpers (jsonParam, numParam) and response helpers (prop, pascal)
  tools/
    itemTypes.ts    Item type CRUD, fields, restrictions, settings, editor discovery, schema health and sync
    pages.ts        Page and area management
    paragraphs.ts   Paragraph management (uses ParagraphNew + ParagraphSave)
    products.ts     Product CRUD, bulk discount, custom/category field value updates
    productSchema.ts Product categories and product field schema management
    files.ts        File and directory browsing
    delivery.ts     Read-only Delivery API
    discovery.ts    Swagger search, endpoint schema, raw API calls

Способы вызова DW API

DynamicWeb Admin API поддерживает три способа вызова:

1. Admin API (GET /admin/api/{Endpoint}) — запросы с URL-параметрами

2. Command API (POST /admin/api/{Endpoint}) — изменения с телом { Model: {...} }. Команды удаления используют плоское тело (без обёртки Model).

3. Update API (POST /Admin/Api/{Endpoint}?Query.Type={Type}) — обновление существующих записей с телом { QueryData: {...}, model: {...} }

DwClient предоставляет отдельные методы для каждого: get(), post(), command(), update(), delivery().

Разработка

npm run dev      # Run with tsx (hot reload)
npm run build    # Compile TypeScript
npm run start    # Run compiled version

После изменений выполните npm run build и перезапустите Claude Code, чтобы он подхватил новую версию.