Files
kompas-plugin/README.md
T

172 lines
12 KiB
Markdown

<p align="center"><img src="assets/banner.svg" alt="kompas — КОМПАС-3D в руках языковой модели" width="100%"></p>
<p align="center">
<b>Плагин, который сажает языковую модель за кульман КОМПАС-3D: она строит детали, собирает сборки,<br>
оформляет чертежи — и сама проверяет, что получилось именно то, о чём просили.</b>
</p>
<p align="center">
Claude Code · Codex · pi · opencode<br>
<sub>КОМПАС-3D v24 / v25 · Windows x64 · .NET 10 · <a href="CHANGELOG.md">что нового</a></sub>
</p>
<p align="center">
<a href="#установка"><b>Установка</b></a> ·
<a href="#что-умеет">Что умеет</a> ·
<a href="#что-внутри">Что внутри</a> ·
<a href="#если-что-то-не-работает">Если что-то не работает</a>
</p>
---
**`kompas`** подключает агента к установленному [КОМПАС-3D](https://ascon.ru/products/7/) (АСКОН) через MCP-сервер. Агент не видит
интерфейса САПР: он работает с моделью через инструменты, а сервер переводит их в вызовы API КОМПАС
и отчитывается фактами, а не кодами возврата. Вместе с сервером приходят навыки с методикой построения.
<p align="center"><img src="assets/flow.svg" alt="Агент вызывает инструменты kompas3d-mcp; сервер управляет КОМПАС-3D через COM и возвращает факты со сверкой" width="100%"></p>
## Как это выглядит
<p align="center"><img src="assets/example.svg" alt="Запрос «кронштейн 150×96×24, стойка 110 с отверстием Ø40, два крепёжных Ø11, высота стойки — переменной» → агент делает семь вызовов от document_create до describe_model → сервер отвечает: построение чистое, тел 1, габарит 150×96×110, переменная H ведёт высоту стойки" width="100%"></p>
<sub>Иллюстрация маршрута: агент сам выбирает инструменты, а методику ему подсказывает навык `kompas-3d`.</sub>
## Что умеет
<table>
<tr>
<td width="100" align="center"><img src="assets/icons/part.svg" width="64" height="64" alt=""><br><b>Детали</b></td>
<td>эскизы списком примитивов (включая текст в кривых), выдавливание, вращение, лофт, кинематика, отверстия, условная резьба, фаски, скругления, оболочка, ребро, массивы, зеркало, уклон, булевы операции</td>
</tr>
<tr>
<td width="100" align="center"><img src="assets/icons/param.svg" width="64" height="64" alt=""><br><b>Параметрика</b></td>
<td>размеры операций — выражения (<code>depth="wall*2"</code>), переменные модели, управляющие размеры эскиза, исполнения в одном файле</td>
</tr>
<tr>
<td width="100" align="center"><img src="assets/icons/assembly.svg" width="64" height="64" alt=""><br><b>Сборки</b></td>
<td>вставка компонентов с поворотом, семь типов сопряжений (в том числе по вспомогательным плоскостям и осям), фиксация, проверка пересечений (объём и зазор — на v25)</td>
</tr>
<tr>
<td width="100" align="center"><img src="assets/icons/drawing.svg" width="64" height="64" alt=""><br><b>Чертежи</b></td>
<td>стандартные виды, разрезы и сечения, размеры с допусками, шероховатость, выноски, штамп, технические требования, фрагменты</td>
</tr>
<tr>
<td width="100" align="center"><img src="assets/icons/import.svg" width="64" height="64" alt=""><br><b>Чужая геометрия</b></td>
<td>импорт STEP, IGES, Parasolid, STL, родных форматов NX/Creo/SolidWorks/Inventor/CATIA, DXF/DWG (STL приходит сеткой, не телом); прямая правка B-rep без дерева построения (часть операций — на v25)</td>
</tr>
<tr>
<td width="100" align="center"><img src="assets/icons/export.svg" width="64" height="64" alt=""><br><b>Выход</b></td>
<td>STEP (AP203/214/242) в другую САПР, STL в слайсер, PNG-снимок модели и растр чертежа; раскраска детали, тел, операций, граней и компонентов сборки — цвет, прозрачность, текстуры</td>
</tr>
<tr>
<td width="100" align="center"><img src="assets/icons/inspect.svg" width="64" height="64" alt=""><br><b>Осмотр</b></td>
<td>один вызов <code>describe_model</code> — дерево, тела, топология, масса, переменные, ошибки, состав сборки; измерение зазоров с двумя ближайшими точками</td>
</tr>
</table>
### Чем отличается
- **Успех проверяется, а не принимается на веру.** КОМПАС умеет «успешно» вырезать мимо материала
или выдавить не в ту сторону. Сервер сверяет результат с параметрами запроса и говорит прямо,
когда вышло не то.
- **Отказ называет причину.** Не «ошибка построения #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
```
Обновление:
```text
/plugin marketplace update kompas-plugin
/plugin update kompas@kompas-plugin
```
Если после обновления инструменты остались прежними — `/reload-plugins`.
### Codex
```powershell
codex plugin marketplace add https://git.shahovalov.ru/mikhail/kompas-plugin.git
```
Затем откройте каталог плагинов Codex, выберите источник `kompas-plugin`, установите `kompas` и
начните новый чат. Обновление — `codex plugin marketplace upgrade kompas-plugin`, затем обновите
плагин в интерфейсе.
### pi
Прилавок — pi-пакет целиком: расширение регистрирует MCP-сервер, оба навыка идут вместе.
```text
pi install git:https://git.shahovalov.ru/mikhail/kompas-plugin.git
```
Обновление — `pi update --extensions`; новые записи [истории изменений](CHANGELOG.md) pi покажет при
следующем запуске (при первой загрузке пакета — нет). Закрепить версию:
```text
pi install git:https://git.shahovalov.ru/mikhail/kompas-plugin.git@v0.7.5
```
Закреплённый тег сам не обновляется: повторите `pi install` с новым тегом или без него, чтобы снова
следовать ветке.
### opencode и ручное подключение
Сниппеты конфигурации лежат в [`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` |
Это репозиторий поставки: здесь лежат собранный сервер и материалы плагина, исходники сервера не
публикуются.
## Лицензия
MIT — см. [LICENSE](LICENSE). На interop-сборки КОМПАС-3D (© АО «АСКОН») лицензия не
распространяется: они в поставку не входят.