Anki Mcp Server

What is Anki MCP Server?

Anki MCP Server is an open-source server designed to enhance the functionality of Anki, a popular flashcard application. This server allows users to create, manage, and sync their Anki decks more efficiently, providing a seamless experience for learners. By leveraging the MCP (Multi-Channel Protocol), the Anki MCP Server enables real-time updates and interactions with Anki clients, making it a valuable tool for educators and students alike.

Features of Anki MCP Server

• Real-Time Synchronization: The server allows for instant updates across devices, ensuring that users always have the latest version of their decks.
• Multi-Channel Support: With MCP, users can connect multiple clients to the server, facilitating collaborative learning and sharing of resources.
• Open Source: Being an open-source project, Anki MCP Server encourages contributions from developers, allowing for continuous improvement and feature enhancements.
• User-Friendly Interface: The server provides an intuitive interface that simplifies the management of Anki decks, making it accessible for users of all skill levels.
• Cross-Platform Compatibility: The server can be used on various operating systems, ensuring that users can access their decks from any device.

How to Set Up Anki MCP Server

1. Installation: Begin by downloading the Anki MCP Server from the official repository on GitHub. Follow the installation instructions provided in the README file.
2. Configuration: After installation, configure the server settings according to your preferences. This may include setting up user accounts and defining access permissions.
3. Connecting Clients: Once the server is running, connect your Anki clients to the server using the provided connection details. This will enable synchronization between the server and your devices.
4. Creating Decks: Start creating and managing your Anki decks through the server interface. You can add cards, organize them into decks, and share them with other users.
5. Syncing Data: Ensure that all your devices are synced with the server to keep your decks updated. You can monitor the synchronization status through the server dashboard.

Frequently Asked Questions

Q: Is Anki MCP Server free to use?

A: Yes, Anki MCP Server is an open-source project and is free to use.

Q: Can I use Anki MCP Server on multiple devices?

A: Absolutely! The server supports multiple devices, allowing you to access your Anki decks from anywhere.

Q: How do I contribute to the Anki MCP Server project?

A: You can contribute by submitting issues, feature requests, or pull requests on the project's GitHub repository.

Q: What are the system requirements for running Anki MCP Server?

A: The server can run on any system that supports the required programming languages and dependencies. Check the documentation for specific requirements.

Q: Is there a community for Anki MCP Server users?

A: Yes, there are various forums and discussion groups where users can share tips, ask questions, and collaborate on projects related to Anki MCP Server.

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 and the 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:

npm install

Build the server:

npm run build

For development with auto-rebuild:

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

{
  "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, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.