Read Frog

Справочник инструментов

Все 29 инструментов MCP по группам разрешений — что каждый делает и что ему требуется.

Двадцать девять инструментов, сгруппированных по разрешению, которое их открывает. Эта таблица нужна, чтобы решить, что выдавать: параметры ваш ассистент читает сам, поэтому здесь они не дублируются.

Прочитайте группы разрешений, прежде чем что-либо выдавать: уровень записи любой группы всегда включает удаление, а удаление каскадно.

Каждый инструмент, который что-то перечисляет, возвращает по одной странице за раз — по умолчанию 20 элементов, максимум 100, — поэтому обход большой notebase занимает несколько вызовов.

Данные аккаунта

Только чтение. У этой группы нет уровня записи.

ИнструментЧто делаетТребуется
whoamiСообщает, для какого аккаунта Read Frog авторизовано подключение. Адрес электронной почты включается только если у подключения есть и разрешение на почту.чтение account

Базы заметок и поля

ИнструментЧто делаетТребуется
list_notebasesПеречисляет принадлежащие вам notebase.чтение notebases
get_notebase_schemaЧитает название одной notebase и определения её полей, включая идентификаторы полей, используемые как ключи при записи заметок. Содержимого заметок не возвращает.чтение notebases
create_notebaseСоздаёт пустую notebase, при желании вместе с начальными полями. Заметки добавляются отдельно.запись notebases
rename_notebaseПереименовывает notebase, не трогая её настройки занятий.запись notebases
delete_notebaseБезвозвратно удаляет notebase вместе с её полями, заметками, шаблонами, карточками и записями повторений.запись notebases
create_notebase_fieldДобавляет поле в notebase и возвращает его идентификатор.запись notebases
update_notebase_fieldПереименовывает поле или меняет его настройки; тип изменить нельзя. Удаление варианта выбора очищает это значение во всех заметках.запись notebases
delete_notebase_fieldУдаляет поле и убирает его значения из каждой заметки. Основные поля и поля, на которые ссылается шаблон, удалить нельзя.запись notebases

Содержимое заметок

ИнструментЧто делаетТребуется
list_notesПросматривает заметки или ищет внутри одной notebase. Поиск — буквальная подстрока без учёта регистра из двух и более символов, совпадает только с текстовыми полями.чтение notes
get_noteЧитает значения полей одной заметки плюс метку времени, защищающую последующие правки.чтение notes
create_notesСоздаёт от 1 до 50 заметок сразу в одной notebase, атомарно. Существующие шаблоны тут же превращают их в карточки.запись notes
update_noteСливает новые значения в заметку, сохраняя неупомянутые поля; null очищает поле. Падает, а не переписывает, если заметка изменилась с момента чтения.запись notes
delete_noteБезвозвратно удаляет заметку вместе с порождёнными из неё карточками и их записями повторений.запись notes

Шаблоны карточек

ИнструментЧто делаетТребуется
list_card_templatesПеречисляет ваши шаблоны карточек, при желании внутри одной notebase.чтение card_templates
get_card_templateЧитает полное определение одного шаблона и метку времени, защищающую последующие правки.чтение card_templates
create_card_templateСоздаёт шаблон из существующих идентификаторов полей. Это порождает карточки для каждой уже имеющейся в notebase заметки.запись card_templates
update_card_templateМеняет название или определение шаблона. Отрисованные карточки следуют за сохранённым шаблоном.запись card_templates
delete_card_templateБезвозвратно удаляет шаблон вместе с порождёнными им карточками и их записями повторений. Исходные заметки остаются.запись card_templates

Отрисованные карточки

Карточка — это содержимое заметки вместе с состоянием расписания, поэтому обоим этим инструментам нужны два разрешения на чтение одновременно.

ИнструментЧто делаетТребуется
list_cardsПросматривает карточки с их отрисованными лицевыми и оборотными сторонами, идентификаторами источников и состоянием изучения. Умеет фильтровать по notebase, шаблону или состоянию расписания.чтение notes + чтение study
get_cardЧитает одну карточку тем же способом.чтение notes + чтение study

Повторения и история обучения

ИнструментЧто делаетТребуется
get_study_statsЧитает счётчики очереди занятий по каждой notebase для заданного часового пояса. Ни содержимого заметок, ни сторон карточек не возвращает.чтение study
get_study_settingsЧитает дневной лимит новых карточек, дневной лимит повторений и желаемое удержание одной notebase. Ни её названия, ни её содержимого не возвращает.чтение study
list_review_historyЧитает ваши записи повторений, при желании с фильтром по notebase или карточке. Содержимое заметок и стороны карточек исключены.чтение study
update_study_settingsМеняет только эти три настройки — дневной лимит новых карточек, дневной лимит повторений, желаемое удержание.запись study
record_reviewОтправляет одну оценку по карточке. FSRS считает её настоящим повторением и обновляет стабильность, сложность и срок карточки. Требует часовой пояс, поскольку он решает, какому учебному дню принадлежит повторение.запись study
undo_reviewОтменяет последнее подходящее повторение одной карточки, возвращая расписание, которое было до него. Требует идентификатор того повторения, поэтому повторная попытка не сможет отменить более раннее.запись study
set_card_suspendedПриостанавливает карточку, убирая её из занятий до возобновления, либо возобновляет её.запись study
set_card_buriedОткладывает карточку, скрывая её до конца учебного дня, либо возвращает её.запись study

Куда двигаться дальше

On this page