MCP
Tool reference
All 32 MCP tools grouped by permission, with what each one does and what it requires.
Thirty-two 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.
| Tool | What it does | Needs |
|---|---|---|
whoami | Reports 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
| Tool | What it does | Needs |
|---|---|---|
list_notebases | Lists the notebases you own. | notebases read |
get_notebase_schema | Reads one notebase's name and field definitions, including the field IDs used as keys when writing notes. Returns no note content. | notebases read |
create_notebase | Creates an empty notebase, optionally with its initial fields. Notes are added separately. | notebases write |
rename_notebase | Renames a notebase, leaving its study settings alone. | notebases write |
delete_notebase | Permanently deletes a notebase together with its fields, notes, templates, cards and review records. | notebases write |
create_notebase_field | Adds a field to a notebase and returns its ID. | notebases write |
update_notebase_field | Renames a field or changes its configuration; the type cannot change. Removing a select option clears that value from every note. | notebases write |
delete_notebase_field | Deletes a field and removes its values from every note. Primary fields, and fields a template names by ID, cannot be deleted. A field a template shows only by looping over every field, as the default dictionary card does, can be deleted and leaves the card. | notebases write |
Note content
| Tool | What it does | Needs |
|---|---|---|
list_notes | Browses 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_note | Reads one note's field values plus the timestamp used to guard later edits. | notes read |
create_notes | Creates 1–50 notes at once in one notebase, atomically. Existing templates turn them into cards straight away. | notes write |
update_notes | Updates 1–50 notes in one notebase atomically. Each note supplies its ID, changed fields and current timestamp; any conflict rolls back the batch. | notes write |
delete_notes | Permanently deletes 1–50 notes and their cards and review records, atomically. The notes may come from different notebases. | notes write |
Card templates
| Tool | What it does | Needs |
|---|---|---|
list_card_templates | Lists your card templates, optionally within one notebase. | card_templates read |
get_card_template | Reads one template's full definition and the timestamp used to guard later edits. | card_templates read |
get_card_template_guide | Reads how card templates work: face shapes, the HTML + Liquid layout syntax, styling and limits. | card_templates read |
preview_card_template | Renders a template on one note without saving anything, and lists any problems in its layouts. | notebases read + notes read |
create_card_template | Creates a template from existing field IDs. This generates cards for every note already in the notebase. | card_templates write |
update_card_template | Changes a template's name or definition. Rendered cards follow the saved template. | card_templates write |
delete_card_template | Permanently 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.
| Tool | What it does | Needs |
|---|---|---|
list_cards | Browses 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_card | Reads one card the same way. | notes read + study read |
Reviews and learning history
| Tool | What it does | Needs |
|---|---|---|
get_study_stats | Reads study queue counts per notebase for a given time zone. Returns no note content or card faces. | study read |
get_study_settings | Reads one notebase's daily new-card limit, daily review limit and desired retention. Returns neither its name nor its content. | study read |
list_review_history | Reads your review records, optionally filtered by notebase or card. Note content and card faces are excluded. | study read |
update_study_settings | Changes only those three settings — daily new-card limit, daily review limit, desired retention. | study write |
record_review | Submits 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_review | Undoes 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_suspended | Suspends a card, taking it out of study until it is resumed, or resumes it. | study write |
set_card_buried | Buries a card, hiding it for the rest of the study day, or unburies it. | study write |
set_notebase_sleep | Puts a notebase to sleep, leaving it out of the review on Home until it is woken, or wakes it. Its cards and review history stay as they are, and it can still be reviewed on its own. | study write |
Where to go next
- Recipes — what these tools are worth combining into.
- Connect an assistant — granting, lowering and revoking permissions.
