@spacholski1225/anki-connect-mcp 1.0.1

package/dist/tools/cards.js

@@ -0,0 +1,118 @@
+import { callAnkiConnect } from '../methods/anki.js';
+/**
+ * Suspend cards by card ID; returns true if successful (at least one card wasn't already suspended) or false otherwise.
+ * @param cards - Array of card IDs to suspend
+ */
+export async function suspend(cards) {
+    const request = {
+        action: 'suspend',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Unsuspend cards by card ID; returns true if successful (at least one card was previously suspended) or false otherwise.
+ * @param cards - Array of card IDs to unsuspend
+ */
+export async function unsuspend(cards) {
+    const request = {
+        action: 'unsuspend',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns an array indicating whether each of the given cards is suspended (in the same order).
+ * @param cards - Array of card IDs to check
+ */
+export async function areSuspended(cards) {
+    const request = {
+        action: 'areSuspended',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns an array indicating whether each of the given cards is due (in the same order).
+ * Note: cards in the learning queue with a large interval (over 20 minutes) are treated as not due
+ * until the time of their interval has passed, to match the way Anki treats them when reviewing.
+ * @param cards - Array of card IDs to check
+ */
+export async function areDue(cards) {
+    const request = {
+        action: 'areDue',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns an array of the most recent intervals for each given card ID, or a 2-dimensional array
+ * of all the intervals for each given card ID when complete is true.
+ * Negative intervals are in seconds and positive intervals in days.
+ * @param cards - Array of card IDs to get intervals for
+ * @param complete - If true, returns all intervals; if false, returns only the most recent interval
+ */
+export async function getIntervals(cards, complete) {
+    const request = {
+        action: 'getIntervals',
+        version: 6,
+        params: Object.assign({ cards }, (complete !== undefined && { complete }))
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns an array of card IDs for a given query. Functionally identical to guiBrowse but doesn't use the GUI for better performance.
+ * @param query - Search query string
+ */
+export async function findCards(query) {
+    const request = {
+        action: 'findCards',
+        version: 6,
+        params: {
+            query
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns an unordered array of note IDs for the given card IDs.
+ * For cards with the same note, the ID is only given once in the array.
+ * @param cards - Array of card IDs to convert to note IDs
+ */
+export async function cardsToNotes(cards) {
+    const request = {
+        action: 'cardsToNotes',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns a list of objects containing for each card ID the card fields, front and back sides including CSS,
+ * note type, the note that the card belongs to, and deck name, as well as ease and interval.
+ * @param cards - Array of card IDs to get information for
+ */
+export async function cardsInfo(cards) {
+    const request = {
+        action: 'cardsInfo',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}

package/dist/tools/decks.js

@@ -0,0 +1,139 @@
+import { callAnkiConnect } from '../methods/anki.js';
+/**
+ * Get the complete list of deck names for the current user
+ */
+export async function deckNames() {
+    const request = {
+        action: 'deckNames',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Get the complete list of deck names and their respective IDs for the current user
+ */
+export async function deckNamesAndIds() {
+    const request = {
+        action: 'deckNamesAndIds',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Accept an array of card IDs and return an object with each deck name as a key,
+ * and its value an array of the given cards which belong to it
+ * @param cards - Array of card IDs
+ */
+export async function getDecks(cards) {
+    const request = {
+        action: 'getDecks',
+        version: 6,
+        params: {
+            cards
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Move cards with the given IDs to a different deck, creating the deck if it doesn't exist yet
+ * @param cards - Array of card IDs to move
+ * @param deck - Name of the target deck
+ */
+export async function changeDeck(cards, deck) {
+    const request = {
+        action: 'changeDeck',
+        version: 6,
+        params: {
+            cards,
+            deck
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Delete decks with the given names
+ * @param decks - Array of deck names to delete
+ * @param cardsToo - If true, cards within deleted decks will also be deleted; otherwise moved to default deck
+ */
+export async function deleteDecks(decks, cardsToo = false) {
+    const request = {
+        action: 'deleteDecks',
+        version: 6,
+        params: {
+            decks,
+            cardsToo
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Get the configuration group object for the given deck
+ * @param deck - Name of the deck
+ */
+export async function getDeckConfig(deck) {
+    const request = {
+        action: 'getDeckConfig',
+        version: 6,
+        params: {
+            deck
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Save the given configuration group, returning true on success or false if the ID is invalid
+ * @param config - Deck configuration object
+ */
+export async function saveDeckConfig(config) {
+    const request = {
+        action: 'saveDeckConfig',
+        version: 6,
+        params: {
+            config
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Change the configuration group for the given decks to the one with the given ID
+ * @param decks - Array of deck names
+ * @param configId - Configuration group ID
+ */
+export async function setDeckConfigId(decks, configId) {
+    const request = {
+        action: 'setDeckConfigId',
+        version: 6,
+        params: {
+            decks,
+            configId
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Create a new configuration group with the given name, cloning from the group with the given ID
+ * @param name - Name for the new configuration group
+ * @param cloneFrom - ID of the configuration group to clone from (optional, defaults to default group)
+ */
+export async function cloneDeckConfigId(name, cloneFrom) {
+    const request = {
+        action: 'cloneDeckConfigId',
+        version: 6,
+        params: Object.assign({ name }, (cloneFrom !== undefined && { cloneFrom }))
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Remove the configuration group with the given ID
+ * @param configId - ID of the configuration group to remove
+ */
+export async function removeDeckConfigId(configId) {
+    const request = {
+        action: 'removeDeckConfigId',
+        version: 6,
+        params: {
+            configId
+        }
+    };
+    return await callAnkiConnect(request);
+}

package/dist/tools/graphical.js

@@ -0,0 +1,133 @@
+import { callAnkiConnect } from '../methods/anki.js';
+/**
+ * Invokes the Card Browser dialog and searches for a given query.
+ * Returns an array of identifiers of the cards that were found.
+ * @param query - Search query for browsing cards
+ */
+export async function guiBrowse(query) {
+    const request = {
+        action: 'guiBrowse',
+        version: 5,
+        params: {
+            query
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Invokes the Add Cards dialog.
+ */
+export async function guiAddCards() {
+    const request = {
+        action: 'guiAddCards',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns information about the current card or null if not in review mode.
+ */
+export async function guiCurrentCard() {
+    const request = {
+        action: 'guiCurrentCard',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Starts or resets the timerStarted value for the current card.
+ * This is useful for deferring the start time to when it is displayed via the API,
+ * allowing the recorded time taken to answer the card to be more accurate when calling guiAnswerCard.
+ */
+export async function guiStartCardTimer() {
+    const request = {
+        action: 'guiStartCardTimer',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Shows question text for the current card; returns true if in review mode or false otherwise.
+ */
+export async function guiShowQuestion() {
+    const request = {
+        action: 'guiShowQuestion',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Shows answer text for the current card; returns true if in review mode or false otherwise.
+ */
+export async function guiShowAnswer() {
+    const request = {
+        action: 'guiShowAnswer',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Answers the current card; returns true if succeeded or false otherwise.
+ * Note that the answer for the current card must be displayed before any answer can be accepted by Anki.
+ * @param ease - Answer ease (1-4: Again, Hard, Good, Easy)
+ */
+export async function guiAnswerCard(ease) {
+    const request = {
+        action: 'guiAnswerCard',
+        version: 5,
+        params: {
+            ease
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Opens the Deck Overview dialog for the deck with the given name;
+ * returns true if succeeded or false otherwise.
+ * @param name - Name of the deck to open overview for
+ */
+export async function guiDeckOverview(name) {
+    const request = {
+        action: 'guiDeckOverview',
+        version: 5,
+        params: {
+            name
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Opens the Deck Browser dialog.
+ */
+export async function guiDeckBrowser() {
+    const request = {
+        action: 'guiDeckBrowser',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Starts review for the deck with the given name; returns true if succeeded or false otherwise.
+ * @param name - Name of the deck to start review for
+ */
+export async function guiDeckReview(name) {
+    const request = {
+        action: 'guiDeckReview',
+        version: 5,
+        params: {
+            name
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Schedules a request to gracefully close Anki.
+ * This operation is asynchronous, so it will return immediately and won't wait until the Anki process actually terminates.
+ */
+export async function guiExitAnki() {
+    const request = {
+        action: 'guiExitAnki',
+        version: 5
+    };
+    return await callAnkiConnect(request);
+}

package/dist/tools/media.js

@@ -0,0 +1,48 @@
+import { callAnkiConnect } from '../methods/anki.js';
+/**
+ * Store a file with the specified base64-encoded contents inside the media folder.
+ * To prevent Anki from removing files not used by any cards (e.g. for configuration files),
+ * prefix the filename with an underscore. These files are still synchronized to AnkiWeb.
+ * @param filename - Name of the file to store
+ * @param data - Base64-encoded file contents
+ */
+export async function storeMediaFile(filename, data) {
+    const request = {
+        action: 'storeMediaFile',
+        version: 6,
+        params: {
+            filename,
+            data
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Retrieve the base64-encoded contents of the specified file.
+ * Returns false if the file does not exist.
+ * @param filename - Name of the file to retrieve
+ */
+export async function retrieveMediaFile(filename) {
+    const request = {
+        action: 'retrieveMediaFile',
+        version: 6,
+        params: {
+            filename
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Delete the specified file inside the media folder.
+ * @param filename - Name of the file to delete
+ */
+export async function deleteMediaFile(filename) {
+    const request = {
+        action: 'deleteMediaFile',
+        version: 6,
+        params: {
+            filename
+        }
+    };
+    return await callAnkiConnect(request);
+}

package/dist/tools/misc.js

@@ -0,0 +1,171 @@
+import { callAnkiConnect } from '../methods/anki.js';
+/**
+ * Get Anki Connect API version
+ */
+export async function getVersion() {
+    const request = {
+        action: 'version',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Get all tags from Anki
+ */
+export async function getTags() {
+    const request = {
+        action: 'getTags',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Get current card information from GUI
+ */
+export async function guiCurrentCard() {
+    const request = {
+        action: 'guiCurrentCard',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Start card timer in GUI
+ */
+export async function guiStartCardTimer() {
+    const request = {
+        action: 'guiStartCardTimer',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Show question in GUI
+ */
+export async function guiShowQuestion() {
+    const request = {
+        action: 'guiShowQuestion',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Show answer in GUI
+ */
+export async function guiShowAnswer() {
+    const request = {
+        action: 'guiShowAnswer',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Answer card in GUI
+ * @param ease - Answer ease (1-4: Again, Hard, Good, Easy)
+ */
+export async function guiAnswerCard(ease) {
+    const request = {
+        action: 'guiAnswerCard',
+        version: 6,
+        params: {
+            ease
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Open deck overview in GUI
+ * @param deckName - Name of the deck to open
+ */
+export async function guiDeckOverview(deckName) {
+    const request = {
+        action: 'guiDeckOverview',
+        version: 6,
+        params: {
+            name: deckName
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Open deck browser in GUI
+ */
+export async function guiDeckBrowser() {
+    const request = {
+        action: 'guiDeckBrowser',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Start deck review in GUI
+ * @param deckName - Name of the deck to review
+ */
+export async function guiDeckReview(deckName) {
+    const request = {
+        action: 'guiDeckReview',
+        version: 6,
+        params: {
+            name: deckName
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Open browse window with query
+ * @param query - Search query for browsing
+ */
+export async function guiBrowse(query) {
+    const request = {
+        action: 'guiBrowse',
+        version: 6,
+        params: {
+            query
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Open add cards dialog in GUI
+ */
+export async function guiAddCards() {
+    const request = {
+        action: 'guiAddCards',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Exit Anki application
+ */
+export async function guiExitAnki() {
+    const request = {
+        action: 'guiExitAnki',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Execute multiple actions in a single request
+ * @param actions - Array of AnkiConnect requests to execute
+ */
+export async function multi(actions) {
+    const request = {
+        action: 'multi',
+        version: 6,
+        params: {
+            actions
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Upgrade Anki Connect (if available)
+ */
+export async function upgrade() {
+    const request = {
+        action: 'upgrade',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}

package/dist/tools/models.js

@@ -0,0 +1,50 @@
+import { callAnkiConnect } from '../methods/anki.js';
+/**
+ * Get the complete list of model names for the current user
+ */
+export async function modelNames() {
+    const request = {
+        action: 'modelNames',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Get the complete list of model names and their corresponding IDs for the current user
+ */
+export async function modelNamesAndIds() {
+    const request = {
+        action: 'modelNamesAndIds',
+        version: 6
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Get the complete list of field names for the provided model name
+ * @param modelName - Name of the model to get field names for
+ */
+export async function modelFieldNames(modelName) {
+    const request = {
+        action: 'modelFieldNames',
+        version: 6,
+        params: {
+            modelName
+        }
+    };
+    return await callAnkiConnect(request);
+}
+/**
+ * Returns an object indicating the fields on the question and answer side of each card template for the given model name.
+ * The question side is given first in each array.
+ * @param modelName - Name of the model to get template fields for
+ */
+export async function modelFieldsOnTemplates(modelName) {
+    const request = {
+        action: 'modelFieldsOnTemplates',
+        version: 6,
+        params: {
+            modelName
+        }
+    };
+    return await callAnkiConnect(request);
+}