Files
kompas-plugin/plugin/README.md
T

6.0 KiB

Плагин kompas

КОМПАС-3D в Claude Code, Codex и pi: инструменты управления (детали, сборки, чертежи, STEP) и методика работы с ними. Витрина и список изменений — прилавок kompas-plugin.

plugin/
├─ bin/                 сервер kompas-mcp.exe, кладёт релиз
├─ skills/              kompas-3d, kompas-fdm-design
├─ commands/doctor.md   /kompas:doctor в Claude Code
├─ scripts/             launch-kompas-mcp.ps1, общий лаунчер всех клиентов
├─ pi/                  расширение для pi-пакета
├─ adapters/            ручное подключение: codex, opencode, pi
└─ assets/              значок плагина

Требования

Windows x64 сервер — COM-клиент КОМПАС, а не автономный CAD-движок, и работает только на той же машине
КОМПАС-3D с компонентом SDK проверено на v25 Home, v24 Home тоже поддерживается; запускать заранее не нужно — сервер присоединится к открытому окну или запустит экземпляр сам
.NET Runtime 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

/plugin marketplace add https://git.shahovalov.ru/mikhail/kompas-plugin.git
/plugin install kompas@kompas-plugin
/kompas:doctor

/kompas:doctor проверяет версию, наличие .NET и КОМПАС, interop-сборки и соединение. Обновление:

/plugin marketplace update kompas-plugin
/plugin update kompas@kompas-plugin

Если инструменты остались прежними — /reload-plugins.

Codex

codex plugin marketplace add https://git.shahovalov.ru/mikhail/kompas-plugin.git

Затем установите kompas из источника kompas-plugin в каталоге плагинов Codex и начните новый чат. Обновление — codex plugin marketplace upgrade kompas-plugin, затем обновите плагин в интерфейсе. Проверка соединения — инструмент kompas_status; если он отвечает «Не подключено», сначала вызовите kompas_connect.

pi

Прилавок — pi-пакет целиком: расширение регистрирует MCP-сервер, навыки идут вместе.

pi install git:https://git.shahovalov.ru/mikhail/kompas-plugin.git
pi list

Обновление — pi update --extensions: пакет без закреплённого ref синхронизируется с веткой. Новые записи CHANGELOG.md pi показывает при следующем запуске (при первой загрузке пакета — нет). Версию можно закрепить тегом:

pi install git:https://git.shahovalov.ru/mikhail/kompas-plugin.git@v0.7.5

Закреплённый тег не меняется при pi update --extensions: для перехода повторите pi install с новым тегом или без ref. Проверка соединения — как в Codex, инструмент kompas_status. Манифест пакета — package.json в корне прилавка, расширение — pi/kompas.ts.

Ручное подключение

Лаунчер scripts/launch-kompas-mcp.ps1 подключается и к другим харнессам — см. adapters/codex/, adapters/opencode/ и adapters/pi/. Это сниппеты и инструкция, а не отдельные дистрибутивы: навыки и лаунчер не размножаются.

Промпты и ресурсы

Сервер отдаёт готовые маршруты работы промптами — part, import-edit-export, drawing, assembly — и они появляются в меню slash-команд Claude Code как /kompas:part (MCP) и т. д. Справочник и сводка активной модели доступны ресурсами kompas://help/<тема> и kompas://active/summary; агент читает их сам, а подстановка через @-упоминание зависит от клиента.

Разработка сервера

Переменная окружения KOMPAS_MCP_EXE подменяет поставленный бинарь своим, и лаунчер не смотрит в bin/ плагина:

$env:KOMPAS_MCP_EXE = "<путь>\kompas-mcp.exe"

Что остаётся после удаления

Каталог %LOCALAPPDATA%\kompas-mcp (распакованные interop-сборки, при разработке — временные файлы) не очищается при обновлении и удалении плагина — удаляется вручную.