|
1 | | -# MCP сервер для API платформы 1С Предприятие |
| 1 | +# MCP сервер для AI-ассистентов (справка по синтаксису и объектной модели 1С:Предприятие) |
2 | 2 |
|
3 | 3 | ## Описание |
4 | 4 |
|
5 | | -MCP (Model Context Protocol) сервер предоставляет стандартизированный доступ к API платформы 1С Предприятие для AI ассистентов. Сервер поддерживает поиск по глобальным методам, свойствам и типам данных платформы через 5 специализированных инструментов. |
| 5 | +MCP (Model Context Protocol) сервер предназначен исключительно для интеграции с AI-ассистентами. Он предоставляет стандартизированный доступ к справочной информации по встроенным функциям, типам, методам и свойствам платформы 1С:Предприятие (аналогично "Синтаксис-помощнику"). Сервер поддерживает поиск и получение справки по объектной модели и синтаксису платформы через 5 специализированных инструментов. |
6 | 6 |
|
7 | 7 | ## Возможности |
8 | 8 |
|
9 | 9 | ### Tool: search |
10 | | -- **Назначение** - поиск по API платформы 1С Предприятие |
| 10 | +- **Назначение** — поиск по справке платформы 1С:Предприятие (встроенные функции, методы, свойства, типы данных) |
11 | 11 | - **Параметры**: |
12 | | - - `query` (обязательный) - поисковый запрос |
13 | | - - `type` (опциональный) - тип элемента (`method`, `property`, `type`) |
14 | | - - `limit` (опциональный) - максимальное количество результатов (1-50, по умолчанию 10) |
| 12 | + - `query` (обязательный) — поисковый запрос |
| 13 | + - `type` (опциональный) — тип элемента (`method`, `property`, `type`) |
| 14 | + - `limit` (опциональный) — максимальное количество результатов (1-50, по умолчанию 10) |
15 | 15 |
|
16 | 16 | ### Tool: info |
17 | | -- **Назначение** - получение детальной информации об элементе API |
| 17 | +- **Назначение** — получение детальной справки об элементе платформы 1С (функция, метод, свойство, тип) |
18 | 18 | - **Параметры**: |
19 | | - - `name` (обязательный) - имя элемента API |
20 | | - - `type` (опциональный) - тип элемента (`method`, `property`, `type`) |
| 19 | + - `name` (обязательный) — имя элемента |
| 20 | + - `type` (опциональный) — тип элемента (`method`, `property`, `type`) |
21 | 21 |
|
22 | 22 | ### Tool: getMember |
23 | | -- **Назначение** - получение информации о методе или свойстве конкретного типа |
| 23 | +- **Назначение** — получение информации о методе или свойстве конкретного типа платформы 1С |
24 | 24 | - **Параметры**: |
25 | | - - `typeName` (обязательный) - имя типа 1С (например, "СправочникСсылка", "ДокументОбъект") |
26 | | - - `memberName` (обязательный) - имя метода или свойства типа |
| 25 | + - `typeName` (обязательный) — имя типа 1С (например, "СправочникСсылка", "ДокументОбъект") |
| 26 | + - `memberName` (обязательный) — имя метода или свойства типа |
27 | 27 |
|
28 | 28 | ### Tool: getMembers |
29 | | -- **Назначение** - получение полного списка всех методов и свойств для указанного типа |
| 29 | +- **Назначение** — получение полного списка всех методов и свойств для указанного типа платформы 1С |
30 | 30 | - **Параметры**: |
31 | | - - `typeName` (обязательный) - имя типа 1С для получения его элементов |
| 31 | + - `typeName` (обязательный) — имя типа 1С для получения его элементов |
32 | 32 |
|
33 | 33 | ### Tool: getConstructors |
34 | | -- **Назначение** - получение списка конструкторов для указанного типа |
| 34 | +- **Назначение** — получение списка способов создания объектов (конструкторов) для указанного типа платформы 1С |
35 | 35 | - **Параметры**: |
36 | | - - `typeName` (обязательный) - имя типа данных 1С (например, "Массив", "Структура", "ТаблицаЗначений") |
| 36 | + - `typeName` (обязательный) — имя типа данных 1С (например, "Массив", "Структура", "ТаблицаЗначений") |
37 | 37 |
|
38 | 38 | ## Алгоритм поиска |
39 | 39 |
|
@@ -63,8 +63,23 @@ MCP (Model Context Protocol) сервер предоставляет станд |
63 | 63 | java -jar build/libs/mcp-bsl-context.jar --platform-path /path/to/1c/platform |
64 | 64 | ``` |
65 | 65 |
|
| 66 | +#### Использование переменных окружения |
| 67 | + |
| 68 | +Вместо передачи параметра `--platform-path` можно задать переменную окружения: |
| 69 | +- `PLATFORM_CONTEXT_PATH` — путь к каталогу установки 1С Предприятия (аналогично `--platform-path`) |
| 70 | + |
| 71 | +Для управления логированием можно задать переменную окружения: |
| 72 | +- `LOG_FILE` — путь к файлу для логов сервера (по умолчанию `mcp-server.log` в рабочей директории) |
| 73 | + |
| 74 | +Пример запуска с переменными окружения: |
| 75 | + |
| 76 | +```bash |
| 77 | +PLATFORM_CONTEXT_PATH="/opt/1cv8/x86_64/8.3.25.1257" LOG_FILE="/tmp/mcp-server.log" \ |
| 78 | + java -jar build/libs/mcp-bsl-context.jar |
| 79 | +``` |
| 80 | + |
66 | 81 | ### Параметры запуска |
67 | | -- `--platform-path` (обязательный) - путь к каталогу установки 1С Предприятия |
| 82 | +- `--platform-path` - путь к каталогу установки 1С Предприятия |
68 | 83 | - `--verbose` - включить отладочное логирование |
69 | 84 | - `--help` - показать справку |
70 | 85 |
|
|
0 commit comments