MCP 服务器

mcp-server-anki

Enables AI tools to manage Anki flashcards, including deck management, card search, creation, editing, deletion, and statistics.

README

MCP Server Anki

中文文档 | English </div>

A Model Context Protocol (MCP) server that bridges Anki with AI tools, enabling intelligent flashcard management and learning assistance.

💡 Compatibility: This server works with any MCP-compatible AI tool including Claude Code, Cline, Zed AI, and more. We use Claude Code as an example in this documentation, but the setup process is similar for other tools.

🌟 Features

📚 Deck Management: Get deck lists, view deck statistics
🔍 Card Search: Search cards using Anki's advanced query syntax
➕ Smart Creation: Create and manage Anki cards with AI assistance
✏️ Card Editing: Update existing card fields and content
🗑️ Card Deletion: Delete unwanted cards and notes
📊 Data Analysis: Get learning statistics and progress information
🔧 Template Management: View and use different note types

📋 Prerequisites

Anki Desktop - Download Anki
AnkiConnect Plugin - Install in Anki (Code: 2055492159)
Node.js - Version 16 or higher
MCP-compatible AI Tool - Such as:
- Claude Code
- Cline
- Zed AI
- Any other tool supporting MCP

🚀 Quick Start

1. Install AnkiConnect

In Anki:

Tools → Add-ons → Get Add-ons
Enter code: 2055492159
Restart Anki

2. Configure Your MCP Client

The following examples use Claude Code, but the configuration is similar for other MCP-compatible tools.

Option A: Using Command Line

# For Claude Code
claude mcp add anki -- npx mcp-server-anki

# For other tools, consult their documentation for the equivalent command

Option B: Manual Configuration

Add the server to your MCP client's configuration file:

{
  "mcp": {
    "servers": {
      "anki": {
        "command": "npx",
        "args": ["mcp-server-anki"]
      }
    }
  }
}

📖 Usage Guide

Basic Workflow

Start Anki - Ensure Anki is running with AnkiConnect enabled
Start MCP Server - Automatically started by Claude Code
Use AI Tools - Interact with Anki through Claude Code

Example Conversations

User: Show me the learning progress for my "English Vocabulary" deck

Claude: I'll check the statistics for your "English Vocabulary" deck...
[Calls get_deck_stats tool]

User: Create a new English word card for "ephemeral"

Claude: I'll create this word card for you...
[Calls add_note tool]

🛠️ Available Tools

Tool Name	Description	Parameters
`get_deck_names`	Get all deck names	None
`get_cards_in_deck`	Get cards from a specific deck	`deckName`
`get_deck_stats`	Get deck statistics	`deckName`
`search_cards`	Search cards	`query`
`add_note`	Add new note	`deckName`, `modelName`, `fields`, `tags`
`update_note`	Update existing note fields	`noteId`, `fields`
`get_note_info`	Get detailed note information	`noteId`
`delete_notes`	Delete one or more notes	`noteIds`
`get_models`	Get all note types	None
`get_model_fields`	Get note type fields	`modelName`

🏗️ Project Structure

mcp-server-anki/
├── src/
│   ├── index.ts           # MCP server entry point
│   ├── ankiConnect.ts      # AnkiConnect API client
│   └── tools/              # MCP tool definitions
│       ├── deckTools.ts    # Deck-related tools
│       ├── cardTools.ts    # Card-related tools
│       └── noteTools.ts    # Note-related tools
├── dist/                   # Compiled JavaScript
├── package.json
├── tsconfig.json
└── README.md

🔧 Development

Build Commands

# Development mode (watch for changes)
npm run dev

# Production build
npm run build

Architecture

Claude Code (MCP Client) ←→ Anki MCP Server ←→ AnkiConnect ←→ Anki Desktop

📝 API Documentation

get_deck_names

Get a list of all deck names.

Returns:

["Default", "English Vocabulary", "Programming"]

search_cards(query)

Search cards using Anki query syntax.

Parameters:

query: Anki query string (e.g., deck:English is:due)

Query Syntax Examples:

deck:DeckName - Specific deck
tag:TagName - By tag
is:due - Due cards
is:new - New cards
added:7 - Cards added in last 7 days

add_note

Add a new note to Anki.

Parameters:

deckName: Target deck name
modelName: Note type (e.g., "Basic", "Cloze")
fields: Field content object
tags: Tag array (optional)

Example:

{
  "deckName": "English Vocabulary",
  "modelName": "Basic",
  "fields": {
    "Front": "ephemeral",
    "Back": "lasting for a very short time"
  },
  "tags": ["vocabulary", "adjective"]
}

update_note

Update fields of an existing note.

Parameters:

noteId: The ID of the note to update
fields: Object with field names and new values

Example:

{
  "noteId": 1234567890,
  "fields": {
    "Back": "lasting for an extremely short time"
  }
}

get_note_info

Get detailed information about a specific note.

Parameters:

noteId: The ID of the note to query

Returns:

{
  "noteId": 1234567890,
  "modelName": "Basic",
  "fields": {
    "Front": "ephemeral",
    "Back": "lasting for a very short time"
  },
  "tags": ["vocabulary", "adjective"]
}

delete_notes

Delete one or more notes.

Parameters:

noteIds: Array of note IDs to delete

Example:

{
  "noteIds": [1234567890, 9876543210]
}

🔧 Building from Source

If you want to contribute or customize the server:

# Clone the repository
git clone https://github.com/here-tunan/mcp-server-anki.git
cd mcp-server-anki

# Install dependencies
npm install

# Build TypeScript
npm run build

To use your local build with Claude Code, configure it with:

{
  "mcp": {
    "servers": {
      "anki": {
        "command": "node",
        "args": ["/path/to/mcp-server-anki/dist/index.js"]
      }
    }
  }
}