# Использование

## Проверка работы

### Статус контейнера

```powershell
docker ps --filter name=1c_help_mcp
```

### Health check

```powershell
Invoke-RestMethod -Uri "http://localhost:8003/health"
```

### Просмотр логов

```powershell
docker logs -f 1c_help_mcp
```

## Работа через Cursor

После настройки `mcp.json` ИИ в Cursor автоматически использует HelpSearchServer для ответов на вопросы о платформе 1С.

### Когда какой инструмент использовать

| Ситуация                             | Инструмент  | Пример                              |
| ------------------------------------ | ----------- | ----------------------------------- |
| Знаете точное имя объекта или метода | `docinfo`   | "ТаблицаЗначений", "Массив.Найти"   |
| Ищете по описанию или вопросу        | `docsearch` | "Как получить остатки на регистре?" |
| `docinfo` не нашёл результат         | `docsearch` | Попробуйте описать функциональность |

### Примеры запросов

#### Получение документации по имени (docinfo)

> "Покажи документацию по ТаблицаЗначений"

ИИ использует `docinfo` с параметром `ТаблицаЗначений` и вернёт полное описание объекта.

> "Какие параметры у Массив.Найти?"

ИИ использует `docinfo` с параметром `Массив.Найти` и вернёт описание метода.

> "Документация по HTTPЗапрос"

ИИ использует `docinfo` для точного поиска объекта `HTTPЗапрос`.

#### Поиск методов (docsearch)

> "Какие параметры у метода Запрос.Выполнить()?"

ИИ найдёт в справке описание метода `Выполнить` объекта `Запрос` и вернёт информацию о параметрах.

#### Поиск по функциональности (docsearch)

> "Как получить остатки на регистре накопления?"

ИИ найдёт разделы справки о виртуальных таблицах регистров накопления.

#### Синтаксис конструкций (docsearch)

> "Как написать условие ВЫБОР в запросе?"

ИИ найдёт описание конструкции ВЫБОР КОГДА в языке запросов.

#### Примеры кода (docsearch)

> "Покажи пример работы с транзакциями"

ИИ найдёт разделы справки с примерами НачатьТранзакцию/ЗафиксироватьТранзакцию.

## Типичные сценарии

### Быстрый поиск по имени

1. Спросите: "Документация по СписокЗначений"
2. ИИ вызовет `docinfo` и вернёт полное описание объекта
3. Попросите уточнить: "А метод НайтиПоЗначению?"

### Изучение нового метода

1. Спросите: "Что делает метод ВыполнитьПакет объекта Запрос?"
2. ИИ найдёт справку и объяснит назначение
3. Попросите пример: "Покажи пример использования"

### Поиск альтернатив

1. Спросите: "Какие есть способы чтения файлов в 1С?"
2. ИИ найдёт все связанные методы и объекты
3. Сравните подходы для вашей задачи

### Уточнение синтаксиса

1. Напишите код с ошибкой
2. Спросите: "Правильно ли я использую этот метод?"
3. ИИ проверит по справке и укажет на ошибки

## Интеграция с другими серверами

HelpSearchServer отлично работает вместе с:

### SyntaxCheckServer

1. HelpSearchServer — объясняет, как правильно
2. SyntaxCheckServer — проверяет синтаксис написанного

### SSLSearchServer

1. HelpSearchServer — справка по платформе
2. SSLSearchServer — справка по БСП

Пример комбинированного запроса:

> "Как в БСП реализована работа с версиями объектов? Какие методы платформы при этом используются?"

## Качество поиска

### От чего зависит

1. **Embedding модель** — Qwen лучше находит по смыслу
2. **Версия платформы** — справка должна соответствовать вашей версии
3. **Формулировка запроса** — конкретные вопросы дают лучшие результаты

### Советы по запросам

**Хорошо:**

* "Какие параметры у метода СформироватьПечатнуюФорму?"
* "Как работает виртуальная таблица ОстаткиИОбороты?"
* "Документация по Запрос" — точный поиск через `docinfo`

**Плохо:**

* "Как работать с 1С?" — слишком общий вопрос
* "Метод" — недостаточно информации

## Ограничения

* Поиск только по справке платформы (не по БСП)
* Нет доступа к справке конфигурации
* Качество зависит от embedding модели

## Мониторинг использования

### Логи запросов

```powershell
docker logs 1c_help_mcp | Select-String "query"
```

### Статистика индекса

```powershell
# Количество проиндексированных документов
docker logs 1c_help_mcp | Select-String "Indexed"
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.onerpa.ru/mcp-servery-1c/servery/help-search-server/ispolzovanie.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.