Equity MCP

Equity MCP Server

MCP сервер для управления личными финансами в приложении Equity.

Когда Применять

Используй этот skill когда:

• Нужно создать, получить, изменить или удалить финансовые данные
• Работаешь с MCP инструментами Equity
• Создаешь новые MCP Tools для Equity
• Отлаживаешь проблемы с MCP сервером

Основные Сущности

Итого: 70 инструментов

Подключение

Авторизация через Sanctum Bearer Token.

Паттерн Создания

ВСЕГДА используй двухшаговый процесс для создания:

1. prepare-{entity} → валидация и preview
2. Подтверждение пользователя
3. create-{entity} → создание

Паттерн Обновления

Для изменения — передавай только изменяемые поля:

1. update-{entity} с {entity}_id + нужные поля

Паттерн Удаления

Для удаления — подтверди с пользователем, затем:

1. delete-{entity} с {entity}_id

Быстрая Справка

Суммы

• В копейках/центах: 10000 = 100.00 RUB (в occurrences/pivot)
• В основной валюте (рублях): 100.00 = 100 рублей (в остальных tools)

Даты

• ISO 8601: YYYY-MM-DD

Типы транзакций

• expense - расход
• income - доход
• transfer - перевод (только recurring)

Типы счетов

• checking, savings, credit, cash, investment, loan, other

Группы счетов

• cash, credit, savings, investment, loan, other

Типы категорий

• expense, income, both

Периоды (Pivot)

• week, month, quarter, year, custom

Ключи метрик (Metric Keys)

• Глобальные: g:income, g:expense, g:balance
• Проектные: p:{project_id}:income, p:{project_id}:expense, p:{project_id}:balance
• Индикаторы: i:p{project_id}:{suffix}
• Ручные: u:p{project_id}:{suffix}

Синтаксис формул (Indicators)

• Ссылка на метрику: p{p}:income (где {p} = ID проекта)
• Арифметика: +, -, *, /
• Скобки: (a + b) * c
• Функции: max(), min(), abs(), round()
• Пример: p{p}:income - p{p}:expense = чистый доход

Паттерн Чтения Метрик

Для получения метрик проекта:

1. get-metrics-range — все метрики за диапазон дат
2. get-metrics-summary — текущий/прошлый месяц + % изменения
3. get-metrics-monthly — тренд по конкретной метрике
4. get-global-metrics — глобальные итоги по всем проектам

Для обновления после изменений данных:

• recompute-metrics — пересчет всех метрик проекта

Паттерн Индикаторов

ВСЕГДА используй двухшаговый процесс:

1. prepare-indicator → валидация формулы и preview
2. Подтверждение пользователя
3. create-indicator → создание

Для проверки формулы без создания:

• validate-expression → проверка синтаксиса и зависимостей

Паттерн Ручных Метрик

Для записи ручной метрики:

1. store-manual-metric с ключом, периодом и значением
2. Серия создается автоматически если не существует

Паттерн Occurrences (План/Факт)

Для анализа плановых и фактических платежей:

1. list-occurrences — все вхождения за период со статусами оплаты
2. get-occurrences-totals — сводка: запланировано/оплачено/не оплачено
3. get-occurrences-by-category — группировка по категориям
4. get-upcoming-occurrences — ближайшие неоплаченные (просроченные первые)

Паттерн Overrides

Для пропуска или переноса конкретного вхождения:

1. create-occurrence-override с type skip или reschedule
2. delete-occurrence-override — отмена пропуска/переноса

Паттерн Links

Для привязки транзакции к повторяющемуся платежу:

1. link-transaction-to-recurring — отметить платеж как оплаченный
2. unlink-transaction-from-recurring — отвязать (вхождение снова "не оплачено")

Паттерн Pivot (Аналитика)

Сводные таблицы по категориям за период:

1. get-dashboard-pivot — общая сводка бюджета
2. get-project-pivot — сводка по конкретному проекту
3. get-subproject-pivot — разбивка по подпроектам

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

См. файл AGENTS.md для детальных примеров использования каждого инструмента.