使用说明

项目简介

Clanki 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在桥接 AI 助手(如 Claude)和 Anki 抽认卡应用。通过 Clanki,AI 助手可以调用工具来创建、更新和管理 Anki 卡片和牌组,从而实现更智能化的学习和知识管理流程。

主要功能点

  • 牌组管理:创建新的 Anki 牌组。
  • 卡片管理:创建和管理基本卡片和挖空卡片(cloze deletion cards)。
  • 内容编辑:更新现有卡片和挖空卡片的内容。
  • 标签管理:为卡片添加和管理标签。
  • 牌组内容查看:查看牌组包含的卡片信息。
  • AnkiConnect 集成:完全集成 AnkiConnect 插件,与本地运行的 Anki 应用无缝连接。

安装步骤

  1. 安装 Anki 和 AnkiConnect 插件

    • 确保您的电脑上已安装 Anki 应用并正在运行。
    • 在 Anki 中安装并启用 AnkiConnect 插件。
  2. 安装 Node.js

    • 确保您的电脑上已安装 Node.js 16 或更高版本。
  3. 克隆仓库

    • 打开终端或命令提示符,执行以下命令克隆 Clanki 仓库到本地:
      git clone https://github.com/jasperket/clanki.git
      cd clanki
  4. 安装依赖

    • 在仓库目录下,执行以下命令安装项目依赖:
      npm install
  5. 构建项目

    • 执行以下命令构建项目:
    npm run build

服务器配置

要让 MCP 客户端(例如 Claude for Desktop)连接到 Clanki 服务器,您需要配置客户端的 MCP 服务器设置。以 Claude for Desktop 为例,编辑 'claude_desktop_config.json' 文件,添加如下配置:

{
  "mcpServers": {
    "clanki": {
      "command": "node",
      "args": ["/absolute/path/to/clanki/build/index.js"]
    }
  }
}
  • '"clanki"': 服务器名称,您可以自定义。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行。
  • '"args": ["/absolute/path/to/clanki/build/index.js"]': 启动服务器的参数,指向 Clanki 构建后的入口文件 'index.js'。请将 '/absolute/path/to/clanki' 替换为 Clanki 仓库在您电脑上的绝对路径。 例如,如果您的 Clanki 仓库在 'C:\Users\YourName\Documents\clanki',则应配置为 '["C:\Users\YourName\Documents\clanki\build\index.js"]' (注意Windows路径中的反斜杠需要转义)。

基本使用方法

配置完成后,当您在 MCP 客户端(如 Claude)中与 AI 助手对话时,可以指示 AI 助手使用 Clanki 提供的工具来操作 Anki。例如:

  • 创建新牌组:您可以指示 AI 助手 "创建一个名为 '英语词汇' 的 Anki 牌组"。AI 助手会调用 'create-deck' 工具,在您的 Anki 应用中创建一个名为 "英语词汇" 的新牌组。
  • 创建新卡片:您可以指示 AI 助手 "在 '英语词汇' 牌组中添加一张卡片,正面是 'apple',背面是 '苹果' "。AI 助手会调用 'create-card' 工具,在 "英语词汇" 牌组中创建一张新的抽认卡。
  • 更新卡片:如果您知道某张卡片的 Note ID,您可以指示 AI 助手 "更新 Note ID 为 12345 的卡片,将正面改为 'banana'"。 AI 助手会调用 'update-card' 工具来更新指定卡片。
  • 创建挖空卡片:您可以指示 AI 助手 "在 '英语语法' 牌组中创建一张挖空卡片,内容是 'The capital of {{c1::France}} is {{c2::Paris}}'"。AI 助手会调用 'create-cloze-card' 工具来创建挖空卡片。

您可以通过类似的方式,使用 AI 助手和 Clanki 提供的其他工具来管理您的 Anki 卡片,提升学习效率。

信息

分类

生产力应用