Anki MCP Server

🚀 Anki MCP Server

An MCP (Model Context Protocol) server that enables interaction between LLMs and the Anki flashcard software, implemented via the AnkiConnect API.

🚀 Quick Start

The Anki MCP Server is a powerful tool that allows LLMs to interact with Anki. Here's how you can get started:

1. Ensure that Anki is installed and the AnkiConnect plugin is enabled.
2. Start the MCP server.
3. Connect your MCP client (e.g., Claude) to this server.

✨ Features

• Create new decks.
• Add notes to existing decks.
• List all available decks and note templates.
• Search for notes using Anki's search syntax.
• Get detailed information about note templates and their fields.
• Add multiple notes in bulk at once.

📦 Installation

Prerequisites

• Node.js (version 14 or higher)
• Anki installed with the AnkiConnect plugin
• A Model Context Protocol-compatible client (e.g., Claude supporting Anthropic MCP)

Steps

1. Ensure Anki is installed and the AnkiConnect plugin is enabled:
   • Install AnkiConnect by going to Tools > Add-ons > Get Add-ons and entering the code: 2055492159.
2. Clone this repository:

   git clone https://github.com/yourusername/anki-mcp-server.git
   cd anki-mcp-server
   

3. Install dependencies:

   npm install
   

4. Build the project:

   npm run build
   

💻 Usage Examples

Basic Usage

1. Make sure Anki is running and AnkiConnect is enabled.
2. Start the MCP server:

   npm start
   

3. Connect your MCP client (e.g., Claude) to this server.

Advanced Usage

The server provides the following tools for MCP clients:

• listDecks: Get a list of all decks in Anki.
• listModels: Get a list of all note templates/types in Anki.
• createDeck: Create a new deck.
• getModel: Get detailed information about a specific note template/type.
• addNote: Add a single note to a deck.
• addNotes: Add multiple notes at once.
• searchNotes: Search for notes using Anki's search syntax.

Creating a New Deck

{
  "name": "createDeck",
  "arguments": {
    "name": "My New Deck"
  }
}

Adding a Single Note

{
  "name": "addNote",
  "arguments": {
    "deckName": "My New Deck",
    "modelName": "Basic",
    "fields": {
      "Front": "What is the capital of France?",
      "Back": "Paris"
    },
    "tags": ["geography", "europe"]
  }
}

Searching for Notes

{
  "name": "searchNotes",
  "arguments": {
    "query": "deck:\"My New Deck\" tag:geography"
  }
}

📚 Documentation

Configuration

The server configuration is located in the config object in src/index.ts. You can modify the following:

• ankiConnectUrl: The URL of the AnkiConnect API (default: http://localhost:8765).
• apiVersion: The AnkiConnect API version (default: 6).
• defaultDeckName: The default deck name to use when not specified (default: Default).

Troubleshooting

Unable to Connect to Anki

• Make sure Anki is running.
• Check if the AnkiConnect plugin is installed and working properly.
• Verify that the AnkiConnect URL is correct (default: http://localhost:8765).

AnkiConnect Permission Issues

• When the server attempts to add cards, AnkiConnect may prompt for permission requests. Make sure to allow the relevant permissions.

By following these steps, you can use this MCP server to enable LLM interaction with Anki.