AggreGate MCP Server

AggreGate MCP Server

MCP (Model Context Protocol) сервер для работы с AggreGate через AI-ассистентов (Cursor, Claude Desktop и др.).

📋 Описание

Этот проект предоставляет MCP сервер, который позволяет AI-ассистентам взаимодействовать с сервером AggreGate через стандартизированный протокол. Сервер предоставляет набор инструментов для управления контекстами, переменными, функциями, событиями, устройствами, пользователями и другими элементами AggreGate.

Для ИИ-агентов (качество разработки на AggreGate)

Обязательный контекст senior-уровня: сначала [AGENTS.md](AGENTS.md), затем [docs/README.md](docs/README.md) (карта всех гайдов). Без этого легко ошибиться в контейнере (models vs alerts), в modelType или в форматах Data Table.

🚀 Быстрый старт

Настройка в Cursor

1. Скомпилируйте проект:

``bash ./gradlew build ``

1. Добавьте конфигурацию MCP сервера в ~/.cursor/mcp.json:

``json { "mcpServers": { "aggregate": { "command": "java", "args": [ "-jar", "C:\\mcp-server\\build\\libs\\aggregate-mcp-server-1.0.0.jar" ] } } } ``

1. Перезапустите Cursor для применения изменений.

Подробные инструкции: [MCPCURSORSETUP.md](MCPCURSORSETUP.md)

📚 Документация

Основные руководства

• [AGENTS.md](AGENTS.md) - Старт для ИИ: senior-контекст AggreGate + MCP (читать первым)
• [MCPCURSORSETUP.md](MCPCURSORSETUP.md) - Настройка MCP сервера в Cursor
• [AIWORKFLOWRULES.md](AIWORKFLOWRULES.md) - Правила рабочего процесса для ИИ
• [AIAUTOTESTINGGUIDE.md](AIAUTOTESTINGGUIDE.md) - Руководство по автоматическому тестированию
• [READMEAIAUTOTESTING.md](READMEAIAUTOTESTING.md) - Обзор автоматического тестирования

Руководства по моделям

Источник истины по кодам modelType для API: 0 = относительная, 1 = абсолютная, 2 = экземплярная — [docs/MCPMODELTYPESGUIDE.md](docs/MCPMODELTYPESGUIDE.md).

• [docs/MCPMODELTYPESGUIDE.md](docs/MCPMODELTYPESGUIDE.md) - Полное руководство по типам моделей (абсолютные, относительные, экземплярные)
• [docs/MCPMODELCOOKBOOKS.md](docs/MCPMODELCOOKBOOKS.md) — пошаговые примеры относительной и экземплярной модели (MCP)

Примеры использования

• [ALLTASKSMCPGUIDE.md](ALLTASKSMCPGUIDE.md) - Руководство по выполнению задач через MCP
• [EXECUTETASKSVIAMCP.md](EXECUTETASKSVIAMCP.md) - Примеры выполнения задач

Документация в папке docs/

Единая карта и полный перечень файлов: [docs/README.md](docs/README.md). Ниже — только самые частые точки входа.

• [docs/MCPAGGREGATECONTEXTSGUIDE.md](docs/MCPAGGREGATECONTEXTSGUIDE.md) — куда создавать объекты в дереве AggreGate
• [docs/MCPSERVERUSAGEGUIDE.md](docs/MCPSERVERUSAGEGUIDE.md) — использование MCP-сервера (в т.ч. запись переменных)
• [docs/MCPMODELTYPESGUIDE.md](docs/MCPMODELTYPESGUIDE.md) — типы моделей 0 / 1 / 2
• [docs/MCPAIQUICKREFERENCE.md](docs/MCPAIQUICKREFERENCE.md) — короткая шпаргалка по вызовам
• [docs/AGGREGATEAPIGUIDE.md](docs/AGGREGATEAPIGUIDE.md) — API и типичные ошибки
• [docs/platform/README.md](docs/platform/README.md) — конспекты платформы (Markdown)
• [docs/MCPOPTIONALTOOLS.md](docs/MCPOPTIONALTOOLS.md) — расширенный набор tools (AGGREGATE_MCP_EXTENDED_TOOLS)

🏗️ Структура проекта

aggregate_mcp/
├── docs/                    # Документация
│   ├── MCP_*.md            # Руководства по MCP
│   ├── AGGREGATE_*.md      # Руководства по AggreGate API
│   └── examples/           # Примеры кода
├── mcp-server/             # Основной модуль MCP сервера
├── modules/                # Дополнительные модули
├── build.gradle.kts        # Конфигурация сборки
└── README.md               # Этот файл

🔧 Сборка

# Сборка проекта
./gradlew build

# Запуск тестов
./gradlew test

# Создание JAR файла
./gradlew jar

📝 Основные возможности

MCP сервер предоставляет инструменты для:

• Подключение и аутентификация: подключение к серверу AggreGate, вход в систему
• Управление контекстами: создание, удаление, получение информации о контекстах
• Работа с переменными: создание, установка значений, получение описаний
• Работа с функциями: создание Expression/Query функций, тестирование, вызов
• Работа с событиями: создание и генерация событий
• Управление устройствами: создание, удаление, получение статуса устройств
• Управление пользователями: создание, обновление, удаление пользователей
• Работа с агентами: создание агентов, отправка событий
• Работа с виджетами и дашбордами: создание и настройка виджетов и дашбордов
• Работа с моделями: создание относительных, абсолютных и экземплярных моделей

🎯 Ключевые правила для ИИ

При работе с MCP сервером через ИИ важно следовать правилам:

1. ⚠️ ВСЕГДА используйте правильный контекст! - Тревоги создаются в alerts, а не в models! См. [MCPAGGREGATECONTEXTSGUIDE.md](docs/MCPAGGREGATECONTEXTSGUIDE.md)
2. Всегда тестировать функции после создания - используйте aggregate_test_function
3. Получать описание переменных перед установкой - используйте aggregate_describe_variable
4. Проверять создание элементов - используйте aggregate_list_* функции
5. Использовать правильные форматы - для Expression функций используйте aggregate_build_expression
6. Создавать привязки для моделей - относительные модели требуют привязок с относительными ссылками

Подробнее: [AIWORKFLOWRULES.md](AIWORKFLOWRULES.md)

📖 Дополнительные ресурсы

• [Репозиторий проекта](REPOSITORY_LINK.txt)
• [JavaDoc документация](docs/) - автоматически сгенерированная документация API
• [Справочник AggreGate](docs/aggregateru5.70.15.chm) - CHM файл (только для Windows)

⚙️ Требования

• Java 11 или выше
• AggreGate Server (для подключения)
• Cursor или другой AI-ассистент с поддержкой MCP

👤 Автор

Свиридов Михаил Юрьевич LCC IoT Solutions

📄 Лицензия

Этот проект распространяется под лицензией MIT. Подробности см. в файле [LICENSE](LICENSE).

MIT License - это разрешительная open source лицензия, которая позволяет свободно использовать, изменять, распространять и использовать программное обеспечение в коммерческих и некоммерческих целях, при условии сохранения уведомления об авторских правах и текста лицензии.

---

Версия: 1.0.0 Последнее обновление: 2025-01-27

Source & license

This open-source MCP server is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: Michaael
• Source: Michaael/AggreGate-MCP-Server
• License: MIT

Install and usage instructions live in the source repository linked above.