https://github.com/scorzeth/anki-mcp-server
An MCP server for Anki
https://github.com/scorzeth/anki-mcp-server
Last synced: 2 months ago
JSON representation
An MCP server for Anki
- Host: GitHub
- URL: https://github.com/scorzeth/anki-mcp-server
- Owner: scorzeth
- Created: 2024-12-11T01:32:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-07T22:52:55.000Z (5 months ago)
- Last Synced: 2025-01-07T23:31:39.858Z (5 months ago)
- Language: JavaScript
- Size: 28.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- Awesome-MCP-Servers-directory - Anki - An MCP server for interacting with your Anki decks and cards (Note Taking)
- awesome-mcp-servers - Anki - Manages and interacts with Anki flashcards via a server, enabling card creation, review, and data retrieval (Table of Contents / Knowledge and Memory)
- awesome-mcp-servers - Anki - Manages and interacts with Anki flashcards via a server, enabling card creation, review, and data retrieval (Table of Contents / Knowledge and Memory)
README
# Anki MCP Server
An MCP server implementation that connects to a locally running Anki, providing card review and creation.
This server is designed to work with the [Anki desktop app](https://apps.ankiweb.net/) and the [Anki-Connect](https://foosoft.net/projects/anki-connect/) add-on.
Make sure you have the add-on installed before using.
## Resources
- **anki://search/deckcurrent**
- Returns all cards from current deck
- Equivalent of `deck:current` in Anki
- **anki://search/isdue**
- Returns cards in review and learning waiting to be studied
- Equivalent of `is:due` in Anki
- **anki://search/isnew**
- Returns all unseen cards
- Equivalent of `is:new` in Anki
## Tools
- **update_cards**
- Marks cards with given card IDs as answered and gives them an ease score between 1 (Again) and 4 (Easy)
- Inputs:
- `answers` (array): Array of objects with `cardId` (number) and `ease` (number) fields
- **add_card**
- Creates a new card in the Default Anki deck
- Inputs:
- `front` (string): Front of card
- `back` (string): Back of card
- **get_due_cards**
- Returns n number of cards currently due for review
- Inputs:
- `num` (number): Number of cards
- **get_new_cards**
- Returns n number of cards from new
- Inputs:
- `num` (number): Number of cards
## Development
Install dependencies:
```bash
npm install
```
Build the server:
```bash
npm run build
```
For development with auto-rebuild:
```bash
npm run watch
```
## Configuration
To use with Claude Desktop, add the server config:
On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"anki-mcp-server": {
"command": "/path/to/anki-mcp-server/build/index.js"
}
}
}
```
### Debugging
Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
```bash
npm run inspector
```
The Inspector will provide a URL to access debugging tools in your browser.