# Инструменты MCP
> Каждый инструмент сервера MCP по правам: что он делает, его аргументы и пример вызова.
>
> Сначала: [Подключить ассистента](https://ocost.io/docs/ru/mcp.md)

Каждый инструмент сервера MCP, записанный из его собственных определений. [Подключить ассистента](https://ocost.io/docs/ru/mcp.md) настраивает сервер. Ассистент читает полное описание каждого инструмента в `tools/list`. Описания аргументов там, как и здесь, на английском.

## `documents:read`

### `get_document`

Читает один документ в формате `ocost.document.v1`, как `GET /public/v1/documents/{document_id}`.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `document_id` | uuid, обязательно | An id Ocost gave (a UUID) |

```json
{
  "name": "get_document",
  "arguments": {
    "document_id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11"
  }
}
```

### `get_file`

Отдаёт статус файла, причину и документы, как `GET /public/v1/files/{file_id}`.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `file_id` | uuid, обязательно | An id Ocost gave (a UUID) |

```json
{
  "name": "get_file",
  "arguments": {
    "file_id": "01a1b08c-6e3a-7562-8f4a-7924722667b1"
  }
}
```

### `list_files`

Перечисляет файлы по их последнему изменению, начиная с самых старых, как `GET /public/v1/files`.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `status` | список `received`, `reading`, `read`, `not_read`, `failed`, `needs_company` | Only files in these statuses |
| `updated_since` | date-time | Files changed at or after this time (ISO 8601) |
| `external_ref` | string | Only the files carrying this id of yours among their external_refs |
| `cursor` | string | `next_cursor` of the page before |
| `limit` | integer 1–100, по умолчанию `50` | Файлов на странице. |

```json
{
  "name": "list_files",
  "arguments": {
    "status": ["read", "not_read", "failed"],
    "updated_since": "2026-11-09T08:00:00Z"
  }
}
```

### `read_document`

Читает страницы документа как текст, до 4 страниц и 12 000 символов.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `document_id` | uuid, обязательно | Идентификатор документа. |
| `pages` | список integer | Номера страниц файла для чтения. |

```json
{
  "name": "read_document",
  "arguments": {
    "document_id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
    "pages": [1, 2]
  }
}
```

### `find_documents`

Перечисляет документы, начиная с самых новых, по виду, группе или компании.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `kind` | `acceptance_protocol`, `agreement`, `bonus_payment_notification`, … (82 значений) | Один тип документа, как его перечисляет `kind_detail` в разделе [Значения](https://ocost.io/docs/ru/document.md#значения). |
| `company_id` | uuid | Идентификатор компании, из `find_company`. |
| `family` | `invoices`, `payments`, `buying`, `contracts`, `reports`, `people`, `other` | Группа видов, например `invoices` или `contracts`. |

```json
{
  "name": "find_documents",
  "arguments": {
    "kind": "credit_note",
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c"
  }
}
```

### `find_contracts`

Перечисляет договоры с их сроком, сроком расторжения и регулярными суммами.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `company_id` | uuid | Идентификатор компании, из `find_company`. |

```json
{
  "name": "find_contracts",
  "arguments": {
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c"
  }
}
```

### `find_company`

Находит поставщиков и клиентов по названию, с их идентификаторами.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `name` | string, по умолчанию `""` | Часть названия. Без неё перечисляются все. |
| `country` | string | Только компании, чей основной адрес в этой стране (ISO 3166-1 alpha-2, `DE`). |
| `relation` | `supplier`, `customer` | Только поставщики или только клиенты. |

```json
{
  "name": "find_company",
  "arguments": {
    "name": "Musterbüro"
  }
}
```

### `find_project`

Находит проекты по названию, с их идентификаторами.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `name` | string, по умолчанию `""` | Часть названия. Без неё перечисляются все. |

```json
{
  "name": "find_project",
  "arguments": {
    "name": "Neubau"
  }
}
```

### `company_documents`

Перечисляет документы компании в обоих направлениях, до 30.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `company_id` | uuid, обязательно | Идентификатор компании, из `find_company`. |

```json
{
  "name": "company_documents",
  "arguments": {
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c"
  }
}
```

### `invoice_detail`

Показывает один счёт так же, как его страница в Ocost: суммы, срок оплаты, скидку, заказ и историю.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `invoice_id` | uuid, обязательно | Идентификатор счёта. |

```json
{
  "name": "invoice_detail",
  "arguments": {
    "invoice_id": "01a1b08c-8c3d-7f41-a2b5-3e4f5a6b7c8d"
  }
}
```

### `open_decisions`

Перечисляет открытые решения подключённого человека, самые срочные первыми.

Только через подключение OAuth, от имени человека, который его разрешил.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `company_id` | uuid | Идентификатор компании, из `find_company`. |
| `project_id` | uuid | Идентификатор проекта, из `find_project`. |

```json
{
  "name": "open_decisions",
  "arguments": {
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c"
  }
}
```

### `check_invoice`

Проверяет счета поставщиков по § 14 UStG и то, является ли каждый электронным счётом.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `document_ids` | список uuid | Счета для проверки, по их идентификаторам. |
| `company_id` | uuid | Идентификатор компании, из `find_company`. |
| `issued_since` | date | Дата документа, начиная с. |
| `issued_until` | date | Дата документа, до. |
| `only_missing` | boolean, по умолчанию `false` | Только счета, в которых чего-то не хватает. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "check_invoice",
  "arguments": {
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c",
    "issued_since": "2026-01-01",
    "only_missing": true
  }
}
```

## `documents:write`

### `send_file`

Отправляет файл в base64, как `POST /public/v1/files`.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `filename` | string, обязательно | Its name, e.g. bill.pdf |
| `content_base64` | string, обязательно | The file's bytes in base64: a PDF, an image (JPEG, PNG, TIFF, WebP), a Word file (.docx, .doc) or an e-invoice's XML (XRechnung, UBL, CII), at most 25 MB |
| `external_ref` | string | Your own id for it, e.g. an Odoo bill's 'account.move,42'; kept and given back, beside the ones sent with the same bytes before |

```json
{
  "name": "send_file",
  "arguments": {
    "filename": "invoice.pdf",
    "content_base64": "JVBERi0xLjcK…",
    "external_ref": "account.move,42"
  }
}
```

## `search:read`

### `search_documents`

Ищет по тексту документов: точно как написано, по ключевым словам, по смыслу или обоими способами.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `query` | string, обязательно | Что найти. |
| `match` | `exact`, `keywords`, `meaning`, `hybrid`, по умолчанию `"hybrid"` | `exact` как написано, `keywords` по словам, `meaning` по смыслу, `hybrid` обоими способами. |
| `document_id` | uuid | Искать только в этом документе. |
| `kinds` | список `acceptance_protocol`, `agreement`, `bonus_payment_notification`, … (82 значений) | Только эти типы документов, как их перечисляет `kind_detail` в разделе [Значения](https://ocost.io/docs/ru/document.md#значения). |
| `family` | `invoices`, `payments`, `buying`, `contracts`, `reports`, `people`, `other` | Группа видов, например `invoices` или `contracts`. |
| `company_id` | uuid | Идентификатор компании, из `find_company`. |
| `project_id` | uuid | Идентификатор проекта, из `find_project`. |
| `site_id` | uuid | Идентификатор объекта. |
| `issued_since` | date | Дата документа, начиная с. |
| `issued_until` | date | Дата документа, до. |
| `due_since` | date | Срок оплаты счёта, начиная с. |
| `due_until` | date | Срок оплаты счёта, до. |
| `gross_min` | десятичное число | Брутто от, в валюте компании. |
| `gross_max` | десятичное число | Брутто до, в валюте компании. |
| `direction` | `incoming`, `outgoing` | `incoming` от поставщиков, `outgoing` клиентам. |
| `status` | `open`, `paid` | Статус счёта: `open` или `paid`. |
| `category` | string | Код ECLASS любого уровня, из `find_category`. |
| `limit` | integer | Сколько строк максимум. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "search_documents",
  "arguments": {
    "query": "Bürostuhl",
    "match": "hybrid",
    "kinds": ["invoice"],
    "issued_since": "2026-01-01"
  }
}
```

### `search`

Ищет документы для глубокого исследования и знаний компании в ChatGPT.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `query` | string, обязательно | What to find |

```json
{
  "name": "search",
  "arguments": {
    "query": "Wartungsvertrag Aufzug"
  }
}
```

### `fetch`

Получает результат `search` целиком: его первые четыре страницы, до 12 000 символов.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `id` | string, обязательно | A result's id |

```json
{
  "name": "fetch",
  "arguments": {
    "id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11"
  }
}
```

## `figures:read`

### `find_category`

Превращает слова на любом из языков Ocost в коды ECLASS.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `words` | string, обязательно | Слова для категории, на любом из языков Ocost. |

```json
{
  "name": "find_category",
  "arguments": {
    "words": "Büromaterial"
  }
}
```

### `company_profile`

Подводит итог последних 12 месяцев компании: куплено, продано, условия, открытые позиции и сроки оплаты.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `company_id` | uuid, обязательно | Идентификатор компании, из `find_company`. |

```json
{
  "name": "company_profile",
  "arguments": {
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c"
  }
}
```

### `project_overview`

Сравнивает план проекта с потраченным и обязательствами, по поставщикам и месяцам.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `project_id` | uuid, обязательно | Идентификатор проекта, из `find_project`. |

```json
{
  "name": "project_overview",
  "arguments": {
    "project_id": "01a1b08c-4b1c-7d20-9a4b-2c3d4e5f6a7b"
  }
}
```

### `query_figures`

Складывает записи для диаграммы, сравнения или подсчёта.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `source` | `documents`, `lines`, `invoices`, … (11 значений), обязательно | Что складывать, например `invoices` или `lines`. |
| `group_by` | список объект (`field`, `bucket`, `level`), обязательно | Одно или два поля: строки, затем столбцы. |
| `measure` | объект (`agg`, `field`, `signed`) | Что складывать: количество или сумму, среднее, минимум или максимум поля. |
| `filters` | список объект (`field`, `values`, `since`, `until`, `min`, `max`) | Условия на поля источника. |
| `year` | integer | Год для подсчёта. `period` его заменяет. |
| `compare` | `previous_period`, `previous_year` | Сравнить с предыдущим периодом или с тем же периодом годом ранее. |
| `top_n` | integer | Только крупнейшие группы. |
| `matching` | объект (`query`, `match`) | Только документы, которые находит поиск. |
| `title` | string | Заголовок таблицы. |
| `period` | string | Простыми словами, например `2025`, `Q3 2025` или `last year`. |

```json
{
  "name": "query_figures",
  "arguments": {
    "source": "invoices",
    "measure": {"agg": "sum", "field": "net"},
    "group_by": [{"field": "company"}],
    "filters": [{"field": "direction", "values": ["incoming"]}],
    "period": "2025",
    "top_n": 10
  }
}
```

### `top_companies`

Ранжирует крупнейших поставщиков или клиентов по нетто за период.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `side` | `suppliers`, `customers`, по умолчанию `"suppliers"` | Поставщики (по умолчанию) или клиенты. |
| `period` | string | Простыми словами, например `2025`, `Q3 2025` или `last year`. |
| `since` | date | С этой даты. |
| `until` | date | До этой даты. |
| `category` | string | Код ECLASS или слова. |
| `n` | integer, по умолчанию `10` | Сколько перечислить. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "top_companies",
  "arguments": {
    "side": "suppliers",
    "period": "2025",
    "n": 10
  }
}
```

### `spend_over_time`

Даёт нетто по месяцам, кварталам или годам, по запросу с разбивкой по компаниям или категориям.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `period` | string | Простыми словами, например `2025`, `Q3 2025` или `last year`. |
| `bucket` | `month`, `quarter`, `year`, по умолчанию `"month"` | Месяц (по умолчанию), квартал или год. |
| `by` | `company`, `category` | Столбец на каждую компанию или на каждый сегмент ECLASS. |
| `side` | `suppliers`, `customers`, по умолчанию `"suppliers"` | Поставщики (по умолчанию) или клиенты. |
| `since` | date | С этой даты. |
| `until` | date | До этой даты. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "spend_over_time",
  "arguments": {
    "period": "last 12 months",
    "bucket": "month",
    "by": "company"
  }
}
```

### `largest_documents`

Перечисляет крупнейшие документы по брутто за период.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `kind` | string | Вид, отличный от счетов к оплате, например `credit_note`. |
| `side` | `suppliers`, `customers`, по умолчанию `"suppliers"` | Поставщики (по умолчанию) или клиенты. |
| `period` | string | Простыми словами, например `2025`, `Q3 2025` или `last year`. |
| `since` | date | С этой даты. |
| `until` | date | До этой даты. |
| `n` | integer, по умолчанию `10` | Сколько перечислить. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "largest_documents",
  "arguments": {
    "period": "Q3 2025",
    "n": 10
  }
}
```

### `payables_due`

Перечисляет неоплаченные счета поставщиков со сроком в заданном окне, сначала сроки Skonto.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `window` | `this_week`, `next_7_days`, `next_14_days`, `next_30_days`, `this_month` | Когда наступает срок оплаты счетов. |
| `since` | date | С этой даты. |
| `until` | date | До этой даты. |
| `company_id` | uuid | Идентификатор компании, из `find_company`. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "payables_due",
  "arguments": {
    "window": "next_14_days"
  }
}
```

### `vat_preview`

Предварительно показывает USt-Voranmeldung по Kennzahl, для проверки налоговым консультантом.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `period` | string | Месяц (`2026-10`) или квартал (`2026-Q4`). |
| `kz` | string | Kennzahl, чтобы перечислить её счета. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "vat_preview",
  "arguments": {
    "period": "2026-10"
  }
}
```

### `find_anomalies`

Отмечает дубликаты счетов, изменённые банковские счета и цены выше заказа.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `since` | date | С этой даты. |
| `until` | date | До этой даты. |
| `kinds` | список `duplicate`, `bank_changed`, `price_above_order` | Только эти отметки. |
| `title` | string | Заголовок таблицы. |

```json
{
  "name": "find_anomalies",
  "arguments": {
    "since": "2026-08-01",
    "until": "2026-10-31",
    "kinds": ["bank_changed"]
  }
}
```

### `supplier_profile`

Подводит итог по поставщику одним вызовом: расходы, условия, скорость оплаты, открытые позиции и цены.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `company_id` | uuid, обязательно | Идентификатор компании, из `find_company`. |

```json
{
  "name": "supplier_profile",
  "arguments": {
    "company_id": "01a1b08c-5c2d-7e10-8b3a-1d2e3f4a5b6c"
  }
}
```

## `exports:write`

### `export_table`

Выгружает таблицу, которую вернул другой инструмент, в Excel или CSV, по ссылке, действующей 30 минут.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `query` | объект (`tool`, `args`), обязательно | `query` таблицы без изменений, как его вернул инструмент. |
| `title` | string, по умолчанию `"Ocost"` | Заголовок таблицы. |
| `format` | `xlsx`, `csv`, по умолчанию `"xlsx"` | Excel (`xlsx`, по умолчанию) или CSV. |

```json
{
  "name": "export_table",
  "arguments": {
    "query": {"tool": "top_companies", "args": {"period": "2025"}},
    "title": "Top suppliers 2025",
    "format": "xlsx"
  }
}
```

### `make_datev_export`

Создаёт выгрузку DATEV за период одним ZIP-архивом, по подписанной ссылке.

Только через подключение OAuth, от имени человека, который его разрешил.

| Аргумент | Тип | Смысл |
| --- | --- | --- |
| `starts_on` | date, обязательно | Первый день периода. |
| `ends_on` | date, обязательно | Последний день периода, в том же финансовом году. |

```json
{
  "name": "make_datev_export",
  "arguments": {
    "starts_on": "2026-10-01",
    "ends_on": "2026-10-31"
  }
}
```

## См. также

- [Подключить ассистента](https://ocost.io/docs/ru/mcp.md): Подключить ассистента к серверу MCP (https://api.ocost.io/public/mcp, те же ключи): Claude Code, Claude Desktop, Cursor, claude.ai и ChatGPT через OAuth и любой клиент.
- [Ключи и права](https://ocost.io/docs/ru/authentication.md): Ключи API: как запрос передаёт ключ, смена ключей, их права и отказы.
- [Документ](https://ocost.io/docs/ru/document.md): Схема ocost.document.v1 в терминах EN 16931 (переносится в UBL и CII): пример, вид и направление, источники, проверки, версии, каждое поле и значение.
- На ocost.io: [API and MCP](https://ocost.io/en/product/api-and-mcp)
