使用说明
项目简介
Anki MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它充当 LLM(大型语言模型)客户端与 Anki 知识卡片软件之间的桥梁。通过此服务器,LLM 客户端能够以标准化的方式与 Anki 进行交互,实现卡片管理、内容检索等功能,从而扩展 LLM 在知识学习和记忆方面的应用能力。
主要功能点
- 卡组管理: 创建新的 Anki 卡组,方便用户组织和分类知识。
- 笔记管理: 向指定卡组添加笔记,支持多种笔记模型和字段,灵活记录知识点。
- 卡片检索: 使用 Anki 强大的搜索语法检索笔记,快速查找所需信息。
- 模型信息: 获取笔记模型的详细信息,了解字段构成和使用方法。
- 批量添加: 支持一次性添加多个笔记,提高录入效率。
安装步骤
-
安装 Anki 及 AnkiConnect 插件:
- 确保已安装 Anki 知识卡片软件。
- 在 Anki 中安装 AnkiConnect 插件。打开 Anki,进入“工具” -> “插件” -> “获取插件”,输入代码 '2055492159' 并安装。
-
克隆仓库:
git clone https://github.com/ethangillani/Anki-MCP-Server.git cd Anki-MCP-Server -
安装依赖: 确保已安装 Node.js (v14 或更高版本) 和 npm。在项目目录下运行:
npm install -
构建项目:
npm run build
服务器配置
MCP 客户端需要配置以下信息以连接到 Anki MCP 服务器。以下为 JSON 格式的配置信息示例,请根据您的实际情况进行配置。
{ "serverName": "AnkiMCP", "command": "npm", "args": ["start"] }
配置参数说明:
- 'serverName': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器,例如 "AnkiMCP"。
- 'command': 启动服务器的命令,这里使用 'npm',因为项目使用 npm 管理和启动。
- 'args': 启动命令的参数,这里使用 '["start"]',对应 package.json 中定义的 'start' 脚本,用于启动服务器。
注意:
- 确保 Anki 软件已在您的电脑上运行,并且 AnkiConnect 插件已启用。
- 默认情况下,服务器会连接到 'http://localhost:8765' 的 AnkiConnect API。您可以在 'src/index.ts' 文件中的 'config' 对象中修改 'ankiConnectUrl' 配置项来更改 AnkiConnect API 的地址。
基本使用方法
-
启动服务器: 在项目目录下运行以下命令启动 Anki MCP 服务器:
npm start启动成功后,您应该看到类似 "Anki MCP Server is running..." 的提示信息。
-
连接 MCP 客户端: 配置您的 MCP 客户端(如 Claude 等支持 MCP 的应用),使其连接到本地运行的 Anki MCP 服务器。客户端需要配置上面提供的服务器配置信息。
-
使用工具: MCP 客户端连接成功后,您可以使用服务器提供的工具与 Anki 进行交互。例如,使用 'listDecks' 工具获取 Anki 中的卡组列表,使用 'addNote' 工具添加新的知识卡片等。具体的工具列表和使用方法请参考仓库的 README.md 文档中的 "Available Tools" 和 "Examples" 部分。
通过 Anki MCP Server,LLM 客户端可以方便地利用 Anki 的知识管理能力,实现更智能化的学习和知识应用场景。
信息
分类
生产力应用