Read Frog

Tool reference

All 29 MCP tools grouped by permission, with what each one does and what it requires.

Twenty-nine tools, grouped by the permission that unlocks them. This table is for deciding what to grant — your assistant reads the parameters itself, so they are not repeated here.

Read the permission groups before granting anything: a group's write level always includes deletion, and deletion cascades.

Every tool that lists things returns one page at a time — 20 items by default, 100 at most — so a large notebase takes several calls to walk through.

Account information

Read-only. This group has no write level.

ToolWhat it doesNeeds
whoamiReports which Read Frog account the connection is authorized as. The email address is included only if the connection also holds the email permission.account read

Notebases and fields

ToolWhat it doesNeeds
list_notebasesLists the notebases you own.notebases read
get_notebase_schemaReads one notebase's name and field definitions, including the field IDs used as keys when writing notes. Returns no note content.notebases read
create_notebaseCreates an empty notebase, optionally with its initial fields. Notes are added separately.notebases write
rename_notebaseRenames a notebase, leaving its study settings alone.notebases write
delete_notebasePermanently deletes a notebase together with its fields, notes, templates, cards and review records.notebases write
create_notebase_fieldAdds a field to a notebase and returns its ID.notebases write
update_notebase_fieldRenames a field or changes its configuration; the type cannot change. Removing a select option clears that value from every note.notebases write
delete_notebase_fieldDeletes a field and removes its values from every note. Primary fields, and fields a template refers to, cannot be deleted.notebases write

Note content

ToolWhat it doesNeeds
list_notesBrowses notes, or searches within one notebase. Search is a literal, case-insensitive substring of two or more characters and only matches text fields.notes read
get_noteReads one note's field values plus the timestamp used to guard later edits.notes read
create_notesCreates 1–50 notes at once in one notebase, atomically. Existing templates turn them into cards straight away.notes write
update_noteMerges new values into a note, keeping fields it does not mention; null clears one. Fails rather than overwriting if the note changed since it was read.notes write
delete_notePermanently deletes a note along with the cards generated from it and their review records.notes write

Card templates

ToolWhat it doesNeeds
list_card_templatesLists your card templates, optionally within one notebase.card_templates read
get_card_templateReads one template's full definition and the timestamp used to guard later edits.card_templates read
create_card_templateCreates a template from existing field IDs. This generates cards for every note already in the notebase.card_templates write
update_card_templateChanges a template's name or definition. Rendered cards follow the saved template.card_templates write
delete_card_templatePermanently deletes a template together with the cards it generated and their review records. Source notes stay.card_templates write

Rendered cards

A card is note content combined with scheduling state, so both of these need two read permissions at once.

ToolWhat it doesNeeds
list_cardsBrowses cards with their rendered fronts and backs, source IDs and learning state. Can filter by notebase, template or schedule status.notes read + study read
get_cardReads one card the same way.notes read + study read

Reviews and learning history

ToolWhat it doesNeeds
get_study_statsReads study queue counts per notebase for a given time zone. Returns no note content or card faces.study read
get_study_settingsReads one notebase's daily new-card limit, daily review limit and desired retention. Returns neither its name nor its content.study read
list_review_historyReads your review records, optionally filtered by notebase or card. Note content and card faces are excluded.study read
update_study_settingsChanges only those three settings — daily new-card limit, daily review limit, desired retention.study write
record_reviewSubmits one rating for a card. FSRS treats it as a real review and updates the card's stability, difficulty and due date. Requires a time zone, since it decides which study day the review belongs to.study write
undo_reviewUndoes the latest eligible review of one card, restoring the schedule it had before. Requires that review's ID, so a retry cannot undo an earlier one.study write
set_card_suspendedSuspends a card, taking it out of study until it is resumed, or resumes it.study write
set_card_buriedBuries a card, hiding it for the rest of the study day, or unburies it.study write

Where to go next

On this page