What is Anki Mcp Server

Anki-MCP-Server is a Model Context Protocol (MCP) server that allows Large Language Models (LLMs) to interact with Anki flashcard software via the AnkiConnect API, facilitating the creation and management of Anki decks.

Use cases

Use cases for Anki-MCP-Server include creating personalized study decks for students, automating the addition of notes from external sources, and integrating flashcard creation into applications that utilize LLMs for educational purposes.

How to use

To use Anki-MCP-Server, ensure that Anki is running with the AnkiConnect add-on enabled. Start the MCP server using the command ‘npm start’ and connect your MCP client (like Claude) to the server.

Key features

Key features of Anki-MCP-Server include the ability to create new decks, add notes to existing decks, list available decks and note models, search for notes using Anki’s search syntax, retrieve detailed information about note models, and bulk add multiple notes at once.

Where to use

Anki-MCP-Server can be used in educational settings, language learning, and any domain where flashcards are beneficial for memorization and knowledge retention.

Anki MCP Server

A Model Context Protocol (MCP) server that enables LLMs to interact with Anki flashcard software through the AnkiConnect API.

Features

• Create new decks in Anki
• Add notes to existing decks
• List available decks and note models
• Search for notes using Anki’s search syntax
• Get detailed information about note models and their fields
• Bulk add multiple notes at once

Prerequisites

• Node.js (v14 or later)
• Anki with the AnkiConnect add-on installed
• A Model Context Protocol compatible client (such as Claude with Anthropic MCP support)

Installation

1. Make sure you have Anki installed with the AnkiConnect add-on

   • Install AnkiConnect by going to Tools > Add-ons > Get Add-ons and entering 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

1. Make sure Anki is running on your computer with AnkiConnect enabled

2. Start the MCP server:

   npm start
   

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

Available Tools

The server provides the following tools to MCP clients:

• listDecks: Get a list of all decks in Anki
• listModels: Get a list of all note models/types in Anki
• createDeck: Create a new deck in Anki
• getModel: Get details about a specific note model/type
• addNote: Add a single note to a deck
• addNotes: Add multiple notes at once
• searchNotes: Search for notes using Anki’s search syntax

Examples

Create a New Deck

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

Add a Note

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

Search Notes

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

Configuration

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

• ankiConnectUrl: URL for the AnkiConnect API (default: http://localhost:8765)
• apiVersion: API version for AnkiConnect (default: 6)
• defaultDeckName: Default deck to use if none specified (default: Default)

Troubleshooting

1. Cannot connect to Anki

   • Make sure Anki is running
   • Check that AnkiConnect add-on is installed and working
   • Verify that the AnkiConnect URL is correct (default: http://localhost:8765)

2. Permission issues with AnkiConnect

   • AnkiConnect may prompt for permission when the server tries to add cards. Look for a popup in Anki.

License

MIT License