Nailuogg Anki MCP Server

🚀 Anki MCP Server

An MCP (Model Context Protocol) server that enables large language models to interact with the Anki flashcard software via AnkiConnect.

🚀 Quick Start

To use the Anki MCP Server, you need to meet the following prerequisites and perform corresponding configurations.

Prerequisites

1. Install Anki.
2. Install the AnkiConnect plugin in Anki.

Configuration

Using with Claude Desktop

Add the server to claude_desktop_config.json:

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

Cline Configuration

Add the server to the cline_mcp_settings.json file in your VSCode settings:

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

✨ Features

Tools

• list_decks - List all available Anki decks.
• create_deck - Create a new Anki deck.
• create_note - Create a new note (basic or cloze).
• batch_create_notes - Create multiple notes at once.
• search_notes - Search for notes using Anki query syntax.
• get_note_info - Get detailed information about a note.
• update_note - Update an existing note.
• delete_note - Delete a note.
• list_note_types - List all available note types.
• create_note_type - Create a new note type.
• get_note_type_info - Get the structure information of a specific note type.

Resources

• anki://decks/all - A complete list of all available decks.
• anki://note-types/all - A list of all available note types.
• anki://note-types/all-with-schemas - Detailed structural information of all note types.
• anki://note-types/{modelName} - Detailed structural information of a specific note type.

📦 Installation

Setup

1. Install dependencies:

npm install

2. Build the server:

npm run build

3. Automatically rebuild during development:

npm run watch

Testing

Run the test suite:

npm test

This will test the following:

• Server initialization
• AnkiConnect communication
• Note operations (create/read/update/delete)
• Deck management
• Error handling

Debugging

Since the MCP server communicates via standard input and output, we recommend using the MCP Inspector:

npm run inspector

This will provide a browser-based interface for:

• Monitoring MCP messages
• Testing tool calls
• Viewing server logs
• Debugging communication issues

💻 Usage Examples

Basic Usage

1. Create a new deck:

Create a new Anki deck named "Programming".

2. Add a basic card:

Create a new card in the "Programming" deck with the front: "What is a closure in JavaScript?" and the back: "A closure is a combination of a function and variables that can retain its scope."

3. Add a cloze card:

Create a new cloze card in the "Programming" deck with the question: "How to use a closure in JavaScript?" and the answer: "It is achieved by defining a function inside another function and capturing variables from the outer function."

🤝 Contribution Guidelines

• When submitting code, please follow the guidelines in the Contributing.md file.
• Submit issues or suggestions to the Issues page.

📄 License

This project is licensed under the MIT License. The specific terms are as follows:

(The full text of the MIT License should be included here)