From 0f482ae5fadfddc48718679b228f9d476571c437 Mon Sep 17 00:00:00 2001 From: Shahovalov MIkhail Date: Wed, 4 Nov 2026 00:57:39 +0300 Subject: [PATCH] =?UTF-8?q?README:=20=D0=B2=D0=B8=D1=82=D1=80=D0=B8=D0=BD?= =?UTF-8?q?=D0=B0=20=D0=B2=20=D0=B4=D1=83=D1=85=D0=B5=20=D0=BE=D1=81=D0=BD?= =?UTF-8?q?=D0=BE=D0=B2=D0=BD=D0=BE=D0=B3=D0=BE=20README,=20=D0=B3=D1=80?= =?UTF-8?q?=D0=B0=D1=84=D0=B8=D0=BA=D0=B0=20=D0=B2=20assets/?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 186 ++++++++++++++++++++++++++------------ assets/banner.svg | 35 +++++++ assets/example.svg | 73 +++++++++++++++ assets/flow.svg | 43 +++++++++ assets/icons/assembly.svg | 1 + assets/icons/drawing.svg | 1 + assets/icons/export.svg | 1 + assets/icons/import.svg | 1 + assets/icons/inspect.svg | 1 + assets/icons/param.svg | 1 + assets/icons/part.svg | 1 + 11 files changed, 287 insertions(+), 57 deletions(-) create mode 100644 assets/banner.svg create mode 100644 assets/example.svg create mode 100644 assets/flow.svg create mode 100644 assets/icons/assembly.svg create mode 100644 assets/icons/drawing.svg create mode 100644 assets/icons/export.svg create mode 100644 assets/icons/import.svg create mode 100644 assets/icons/inspect.svg create mode 100644 assets/icons/param.svg create mode 100644 assets/icons/part.svg diff --git a/README.md b/README.md index 53ac25d..032f7fe 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,169 @@ -# КОМПАС-3D в Claude Code, Codex и pi +

kompas — КОМПАС-3D в руках языковой модели

-Каталог плагинов с одним плагином — **`kompas`**. Он даёт Claude Code управление -[КОМПАС-3D](https://ascon.ru/products/7/) (АСКОН) через MCP-сервер: детали, эскизы, -формообразующие операции, массивы и зеркало, отверстия, сборки с сопряжениями, 2D-чертежи, -STEP/STL, осмотр и измерение модели — плюс два навыка с методикой построения. +

+Плагин, который сажает языковую модель за кульман КОМПАС-3D: она строит детали, собирает сборки,
+оформляет чертежи — и сама проверяет, что получилось именно то, о чём просили.
+

-Это репозиторий поставки: здесь лежит собранный сервер и материалы плагина. Исходники сервера -не публикуются. +

+Claude Code · Codex · pi · opencode
+КОМПАС-3D v24 / v25 · Windows x64 · .NET 10 · что нового +

-## Что нужно до установки +

+Установка · +Что умеет · +Что внутри · +Если что-то не работает +

-- **Windows x64** — сервер является COM-клиентом КОМПАС и работает только на той же машине; -- **установленный КОМПАС-3D** (проверено на v25 Home, v24 Home тоже поддерживается) **с компонентом SDK**. Interop-сборки - принадлежат АСКОН, в поставку не входят и берутся из установки - (`SDK\Samples\CSharp.zip`, каталог `Common`); при первом запуске они распаковываются - в `%LOCALAPPDATA%\kompas-mcp\interop\<ключ>`. Если SDK не установлен, укажите каталог - с этими сборками в переменной окружения `KOMPAS_INTEROP_DIR`; -- **[.NET Runtime](https://dotnet.microsoft.com/download/dotnet) 10 или новее, x64** — сервер - поставляется framework-dependent (2,3 МБ вместо 34), поэтому рантайм берётся с машины. - Проверить: `dotnet --list-runtimes` должен показать `Microsoft.NETCore.App 10.x` или новее; -- чекаут и рабочие файлы — вне синхронизируемых папок OneDrive. +--- -Запускать КОМПАС заранее не нужно: сервер присоединится к открытому окну, а если его нет — -запустит экземпляр сам. +**`kompas`** подключает агента к установленному [КОМПАС-3D](https://ascon.ru/products/7/) (АСКОН) через MCP-сервер. Агент не видит +интерфейса САПР: он работает с моделью через инструменты, а сервер переводит их в вызовы API КОМПАС +и отчитывается фактами, а не кодами возврата. Вместе с сервером приходят навыки с методикой построения. -## Установка в Claude Code +

Агент вызывает инструменты kompas3d-mcp; сервер управляет КОМПАС-3D через COM и возвращает факты со сверкой

-``` +## Как это выглядит + +

Запрос «кронштейн 150×96×24, стойка 110 с отверстием Ø40, два крепёжных Ø11, высота стойки — переменной» → агент делает семь вызовов от document_create до describe_model → сервер отвечает: построение чистое, тел 1, габарит 150×96×110, переменная H ведёт высоту стойки

+ +Иллюстрация маршрута: агент сам выбирает инструменты, а методику ему подсказывает навык `kompas-3d`. + +## Что умеет + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Детали
эскизы списком примитивов (включая текст в кривых), выдавливание, вращение, лофт, кинематика, отверстия, условная резьба, фаски, скругления, оболочка, ребро, массивы, зеркало, уклон, булевы операции

Параметрика
размеры операций — выражения (depth="wall*2"), переменные модели, управляющие размеры эскиза, исполнения в одном файле

Сборки
вставка компонентов с поворотом, семь типов сопряжений (в том числе по вспомогательным плоскостям и осям), фиксация, проверка пересечений (объём и зазор — на v25)

Чертежи
стандартные виды, разрезы и сечения, размеры с допусками, шероховатость, выноски, штамп, технические требования, фрагменты

Чужая геометрия
импорт STEP, IGES, Parasolid, STL, родных форматов NX/Creo/SolidWorks/Inventor/CATIA, DXF/DWG (STL приходит сеткой, не телом); прямая правка B-rep без дерева построения (часть операций — на v25)

Выход
STEP (AP203/214/242) в другую САПР, STL в слайсер, PNG-снимок модели и растр чертежа; раскраска детали, тел, операций, граней и компонентов сборки — цвет, прозрачность, текстуры

Осмотр
один вызов describe_model — дерево, тела, топология, масса, переменные, ошибки, состав сборки; измерение зазоров с двумя ближайшими точками
+ +### Чем отличается + +- **Успех проверяется, а не принимается на веру.** КОМПАС умеет «успешно» вырезать мимо материала + или выдавить не в ту сторону. Сервер сверяет результат с параметрами запроса и говорит прямо, + когда вышло не то. +- **Отказ называет причину.** Не «ошибка построения #37», а «катет больше длины 20 из 54 рёбер: + `[110]` 0.171 мм … возьмите меньше» или координаты разомкнутого конца контура. +- **Модель остаётся параметрической.** Размеры связаны выражениями с переменными, и + правка одной переменной перестраивает деталь — как у инженера, а не как у скрипта. +- **Агенты не мешают друг другу.** Режим `private` (`KOMPAS_MCP_INSTANCE=private` или + `kompas_connect(instance="private")`) поднимает собственный скрытый экземпляр КОМПАС, и параллельная + сессия не уведёт активный документ. По умолчанию сервер работает в общем окне пользователя. + +## Установка + +### Что нужно заранее + +| | | +|---|---| +| **Windows x64** | сервер — COM-клиент КОМПАС и работает только на той же машине | +| **КОМПАС-3D с компонентом SDK** | проверено на v25 Home, v24 Home тоже поддерживается; запускать заранее не нужно — сервер присоединится к открытому окну или запустит экземпляр сам | +| **[.NET Runtime](https://dotnet.microsoft.com/download/dotnet) 10+, x64** | сервер поставляется framework-dependent, рантайм берётся с машины; `dotnet --list-runtimes` должен показать `Microsoft.NETCore.App 10.x` или новее | +| **Папка вне OneDrive** | клон и рабочие файлы не должны лежать в синхронизируемых папках | + +Interop-сборки принадлежат АСКОН и в поставку не входят. Они берутся из установки +(`SDK\Samples\CSharp.zip`, каталог `Common`) и при первом запуске распаковываются в +`%LOCALAPPDATA%\kompas-mcp\interop\<ключ>`. Без SDK укажите каталог со сборками в +`KOMPAS_INTEROP_DIR`. + +### Claude Code + +```text /plugin marketplace add https://git.shahovalov.ru/mikhail/kompas-plugin.git /plugin install kompas@kompas-plugin /kompas:doctor ``` -`/kompas:doctor` — диагностика: версия сервера, установлен ли КОМПАС, на месте ли interop-сборки, -проходит ли соединение. С неё стоит начинать разбор любой неполадки. +Обновление: -## Обновление в Claude Code - -``` +```text /plugin marketplace update kompas-plugin /plugin update kompas@kompas-plugin ``` Если после обновления инструменты остались прежними — `/reload-plugins`. -## Что внутри - -| | | -|---|---| -| **MCP-сервер `kompas`** | 78 инструментов: документы, эскизы, выдавливание/вращение/по сечениям/по траектории, оболочка, рёбра, уклон, скругления и фаски, массивы и зеркало, отверстия, булевы операции, прямое редактирование B-rep, переменные и параметризация, **исполнения** (несколько геометрий одной модели в одном файле), внешний вид (цвет, прозрачность, текстуры), сборки и сопряжения (в том числе по вспомогательным плоскостям и осям), 2D-чертежи (виды, размеры, обозначения, тех. требования), STEP/STL, осмотр (`describe_model`, `list_faces`, `list_edges`, `measure`) | -| **Навык `kompas-3d`** | методика построения: порядок работы, выбор подхода, проверенные приёмы и ловушки | -| **Навык `kompas-fdm-design`** | проектирование под FDM/FFF-печать: нависания, толщины стенок, зазоры и посадки, ориентация, бобышки и защёлки | -| **Команда `/kompas:doctor`** | диагностика установки | -| **Справка `help`** | инструмент `help(topic=…)` — статьи по механике и ловушкам, прямо в сессии | - -## Установка в Codex - -В терминале зарегистрируйте публичный каталог: +### Codex ```powershell codex plugin marketplace add https://git.shahovalov.ru/mikhail/kompas-plugin.git ``` -Затем откройте каталог плагинов Codex, выберите источник `kompas-plugin` и установите `kompas`. -Откройте новый чат с плагином: сервер и оба навыка поставляются вместе. Для обновления каталога -используйте `codex plugin marketplace upgrade kompas-plugin`, затем обновите плагин в интерфейсе. -Команда `/kompas:doctor` относится к Claude Code; в Codex проверяйте подключение через `kompas_status`. +Затем откройте каталог плагинов Codex, выберите источник `kompas-plugin`, установите `kompas` и +начните новый чат. Обновление — `codex plugin marketplace upgrade kompas-plugin`, затем обновите +плагин в интерфейсе. -## Установка в pi +### pi Прилавок — pi-пакет целиком: расширение регистрирует MCP-сервер, оба навыка идут вместе. -``` +```text pi install git:https://git.shahovalov.ru/mikhail/kompas-plugin.git ``` -Обновление — `pi update --extensions`. После обновления новые записи из -[CHANGELOG.md](CHANGELOG.md) показываются при следующем новом запуске pi -(при первой загрузке пакета — нет). +Обновление — `pi update --extensions`; новые записи [истории изменений](CHANGELOG.md) pi покажет при +следующем запуске (при первой загрузке пакета — нет). Закрепить версию: -Для закрепления версии: - -``` +```text pi install git:https://git.shahovalov.ru/mikhail/kompas-plugin.git@v0.7.5 ``` -Закреплённый тег не обновляется до следующего релиза автоматически: повторите `pi install` -с новым тегом или без ref, чтобы снова следовать ветке. Проверка соединения — `kompas_status`. +Закреплённый тег сам не обновляется: повторите `pi install` с новым тегом или без него, чтобы снова +следовать ветке. -## Другие агентские харнессы +### opencode и ручное подключение -Тот же сервер можно подключить вручную к Codex, opencode и pi — сниппеты конфигурации лежат в -`plugin/adapters/{codex,opencode,pi}/`. +Сниппеты конфигурации лежат в [`plugin/adapters/`](plugin/adapters): +[opencode](plugin/adapters/opencode/README.md), [Codex](plugin/adapters/codex/README.md), +[pi](plugin/adapters/pi/README.md). Все они запускают тот же сервер, что и плагин. + +## Что внутри + +| | | +|---|---| +| **MCP-сервер `kompas`** | весь каталог инструментов; сервер едет в плагине, отдельно ставить нечего | +| **Навык `kompas-3d`** | методика построения: порядок работы, выбор подхода, проверенные приёмы и ловушки | +| **Навык `kompas-fdm-design`** | проектирование под FDM-печать: нависания, толщины стенок, зазоры и посадки, ориентация, бобышки и защёлки | +| **Справка `help`** | `help(topic=…)` — статьи по механике и ловушкам, прямо в сессии | +| **Команда `/kompas:doctor`** | диагностика установки в Claude Code | + +## Если что-то не работает + +| Клиент | Проверка | +|---|---| +| Claude Code | `/kompas:doctor` — версия сервера, КОМПАС, interop-сборки, соединение | +| Codex, pi, opencode | инструмент `kompas_status`; ответ «Не подключено» значит, что сначала нужен `kompas_connect` | +| Инструментов нет совсем | сервер не запустился: проверьте `dotnet --list-runtimes` | + +Это репозиторий поставки: здесь лежат собранный сервер и материалы плагина, исходники сервера не +публикуются. ## Лицензия diff --git a/assets/banner.svg b/assets/banner.svg new file mode 100644 index 0000000..d2b19c6 --- /dev/null +++ b/assets/banner.svg @@ -0,0 +1,35 @@ + + + + + + + + + + + + +150Ø40 +MODEL CONTEXT PROTOCOL · COM API5/API7 +kompas3d-mcp +КОМПАС-3D в руках языковой модели +эскизы3D-деталисборкичертежиSTEP · STL · DXF +ГОСТ 2.317 · изометрия + + + diff --git a/assets/example.svg b/assets/example.svg new file mode 100644 index 0000000..99d3ed0 --- /dev/null +++ b/assets/example.svg @@ -0,0 +1,73 @@ + + + + + + + + +01 · ЗАПРОС +Вы + +02 · ВЫЗОВЫ +Агент + +03 · ОТВЕТ +Сервер + + + +Кронштейн: +полка 150 × 96 × 24, +стойка высотой 110 +с отверстием Ø40, +в полке два +крепёжных Ø11. +Высоту стойки — +переменной. + +1 +document_create(part) + +2 +set_variable(H = 110) + +3 +primitive(block 150×96×24) + +4 +primitive(height = "H", +result = union) + +5 +hole(Ø40, сквозное) + +6 +hole(Ø11, points = [2]) + +7 +describe_model(box, mass) +H +✓ Построение чистое +тел: 1 +габарит 150 × 96 × 110 мм +H ведёт высоту стойки: +set_variable(H = 140) + diff --git a/assets/flow.svg b/assets/flow.svg new file mode 100644 index 0000000..bfce236 --- /dev/null +++ b/assets/flow.svg @@ -0,0 +1,43 @@ + + + + + + + + + +LLM-агент +Claude Code · Codex · pi · opencode +навыки kompas-3d и +kompas-fdm-design + +kompas3d-mcp +инструменты · справка help +STA-поток, хендлы, +сверка с запросом + +КОМПАС-3D +COM API7 / API5 +окно пользователя или +свой скрытый экземпляр + + + + + + + + +вызовинструмента +COM-вызовы +факты +сверка +геометрия,дерево, ошибки +MCP +COM + diff --git a/assets/icons/assembly.svg b/assets/icons/assembly.svg new file mode 100644 index 0000000..adc9e76 --- /dev/null +++ b/assets/icons/assembly.svg @@ -0,0 +1 @@ +Сборки diff --git a/assets/icons/drawing.svg b/assets/icons/drawing.svg new file mode 100644 index 0000000..2d738c7 --- /dev/null +++ b/assets/icons/drawing.svg @@ -0,0 +1 @@ +Чертежи diff --git a/assets/icons/export.svg b/assets/icons/export.svg new file mode 100644 index 0000000..428f961 --- /dev/null +++ b/assets/icons/export.svg @@ -0,0 +1 @@ +Экспорт diff --git a/assets/icons/import.svg b/assets/icons/import.svg new file mode 100644 index 0000000..60d953d --- /dev/null +++ b/assets/icons/import.svg @@ -0,0 +1 @@ +Импорт diff --git a/assets/icons/inspect.svg b/assets/icons/inspect.svg new file mode 100644 index 0000000..913b351 --- /dev/null +++ b/assets/icons/inspect.svg @@ -0,0 +1 @@ +Осмотр diff --git a/assets/icons/param.svg b/assets/icons/param.svg new file mode 100644 index 0000000..ba13f4b --- /dev/null +++ b/assets/icons/param.svg @@ -0,0 +1 @@ +ПараметрикаH*2 diff --git a/assets/icons/part.svg b/assets/icons/part.svg new file mode 100644 index 0000000..8f8d3ef --- /dev/null +++ b/assets/icons/part.svg @@ -0,0 +1 @@ +Детали