Anki Cards (Clanki)

🚀 Clanki - Anki Plugin Integrated with Claude

A MCP server that allows AI assistants like Claude to interact with Anki flashcard libraries through the Model Context Protocol (MCP).

🚀 Quick Start

Clanki is a powerful tool that enables AI assistants such as Claude to interact with Anki flashcard libraries. Before using it, make sure you meet the prerequisites and follow the installation and setup steps below.

✨ Features

• Create and manage Anki card libraries.
• Create basic front-and-back cards.
• Create Cloze cards with deletion functionality.
• Update existing cards and Cloze deletion items.
• Add and manage tags.
• View the contents of card libraries and card information.
• Fully integrated with AnkiConnect.

📦 Installation

Prerequisites

• Anki installed and running.
• AnkiConnect plugin installed and enabled in Anki.
• Node.js version 16 or higher.

Steps

1. Clone this repository:

git clone https://github.com/yourusername/clanki.git
cd clanki

2. Install dependencies:

npm install

3. Build the project:

npm run build

📚 Documentation

Setup Steps

1. Ensure Anki is running and the AnkiConnect plugin is installed and enabled.
2. Edit the claude_desktop_config.json file to configure Claude Desktop to use the server:

{
  "mcpServers": {
    "clanki": {
      "command": "node",
      "args": ["/absolute/path/to/clanki/build/index.js"]
    }
  }
}

Replace /absolute/path/to/clanki with the actual installation path of Clanki.

Available Tools

create-deck

Create a new Anki card library.

• Parameters:
  • name: The name of the new card library.

create-card

Create a new basic flashcard in the specified card library.

• Parameters:
  • deckName: The name of the card library to which the card belongs.
  • front: The content on the front of the card.
  • back: The content on the back of the card.
  • tags: (Optional) An array of tags for the card.

create-cloze-card

Create a new Cloze deletion flashcard in the specified card library.

• Parameters:
  • deckName: The name of the card library to which the card belongs.
  • text: The text content containing the Cloze deletion syntax {{c1::text}}.
  • backExtra: (Optional) Additional information displayed on the back of the card.
  • tags: (Optional) An array of tags for the card.

update-card

Update an existing basic flashcard.

• Parameters:
  • noteId: The ID of the note to be updated.
  • front: (Optional) New front content.
  • back: (Optional) New back content.
  • tags: (Optional) A new array of tags.

update-cloze-card

Update an existing Cloze deletion flashcard.

• Parameters:
  • noteId: The ID of the note to be updated.
  • text: (Optional) New text content containing the Cloze syntax.
  • backExtra: (Optional) New additional information on the back.
  • tags: (Optional) A new array of tags.

Development Guide

To modify or extend the server:

1. Modify the src/index.ts file.
2. Rebuild the project using npm run build.
3. Debug using npx @modelcontextprotocol/inspector node build/index.js.