Skip to content

z1lc/clanki

 
 

Repository files navigation

MseeP.ai Security Assessment Badge License: MIT

Clanki - Claude's Anki Integration

An MCP server that enables AI assistants like Claude to interact with Anki flashcard decks through the Model Context Protocol (MCP).

Features

  • Create and manage Anki decks
  • Create basic flashcards with front/back content
  • Create cloze deletion cards
  • Update existing cards and cloze deletions
  • Add and manage tags
  • View deck contents and card information
  • Full integration with AnkiConnect

Prerequisites

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

Installation

  1. Clone this repository:
git clone https://github.com/yourusername/clanki.git
cd clanki
  1. Install dependencies:
npm install
  1. Build the project:
npm run build

Setup

  1. Make sure Anki is running and the AnkiConnect plugin is installed and enabled

  2. Configure Claude for Desktop to use the server by editing claude_desktop_config.json:

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

Replace /absolute/path/to/clanki with the actual path to your clanki installation.

Available Tools

Tools exist for searching across the collection as well as creating three types of notes: basic; interview question; and programming language function.

Development

To modify or extend the server:

  1. Make changes to src/index.ts
  2. Rebuild with npm run build
  3. Debug with npx @modelcontextprotocol/inspector node build/index.js

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Acknowledgments

About

An MCP server for connecting Claude Desktop with Anki Flashcards.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 97.3%
  • Shell 1.8%
  • Dockerfile 0.9%