article
README
🚀 Anki MCP 服务器
Anki MCP 服务器是一个支持大语言模型(LLM)与 Anki 理解卡片软件交互的模型上下文协议(MCP)服务器,它借助 AnkiConnect API 来实现交互功能,为用户提供了便捷的卡片管理体验。
🚀 快速开始
要使用 Anki MCP 服务器,您需要先完成一些准备工作,然后按照安装步骤进行操作,最后就可以开始使用啦。
✨ 主要特性
- 牌组管理:能够创建新的牌组,还能列出所有可用的牌组。
- 笔记操作:可以将笔记添加到现有的牌组中,支持单条添加和批量添加;同时能使用 Anki 的搜索语法搜索笔记。
- 模板信息:可获取所有笔记模板/类型的列表,以及特定笔记模板/类型的详细信息。
📦 安装指南
- 安装 Anki 并启用 AnkiConnect 插件:
- 打开 Anki,通过「工具」>「插件」>「获取插件」,输入代码
2055492159来安装 AnkiConnect。
- 打开 Anki,通过「工具」>「插件」>「获取插件」,输入代码
- 克隆仓库:
git clone https://github.com/yourusername/anki-mcp-server.git cd anki-mcp-server - 安装依赖项:
npm install - 构建项目:
npm run build
💻 使用示例
基础用法
启动服务器
- 确保 Anki 已运行且 AnkiConnect 启用。
- 启动 MCP 服务器:
npm start - 将您的 MCP 客户端(例如 Claude)连接到此服务器。
调用工具示例
创建新牌组
{
"name": "createDeck",
"arguments": {
"name": "My New Deck"
}
}
添加一条笔记
{
"name": "addNote",
"arguments": {
"deckName": "My New Deck",
"modelName": "Basic",
"fields": {
"Front": "What is the capital of France?",
"Back": "Paris"
},
"tags": ["geography", "europe"]
}
}
搜索笔记
{
"name": "searchNotes",
"arguments": {
"query": "deck:\"My New Deck\" tag:geography"
}
}
📚 详细文档
可用工具
该服务器为 MCP 客户端提供了以下工具:
- listDecks:获取 Anki 中所有牌组的列表。
- listModels:获取 Anki 中所有笔记模板/类型的列表。
- createDeck:创建新的牌组。
- getModel:获取特定笔记模板/类型的详细信息。
- addNote:向牌组中添加单条笔记。
- addNotes:一次添加多条笔记。
- searchNotes:使用 Anki 的搜索语法搜索笔记。
配置
服务器配置位于 src/index.ts 中的 config 对象。您可以修改以下内容:
ankiConnectUrl:AnkiConnect API 的 URL(默认:http://localhost:8765)。apiVersion:AnkiConnect API 版本(默认:6)。defaultDeckName:未指定时使用的默认牌组名称(默认:Default)。
🔧 技术细节
先决条件
- Node.js(版本 14 或更高)。
- 安装了 Anki 并安装了 AnkiConnect 插件。
- 具备模型上下文协议兼容客户端(例如支持 Anthropic MCP 的 Claude)。
🔧 故障排除
无法连接到 Anki
- 确保 Anki 已运行。
- 检查 AnkiConnect 插件是否已安装且正常工作。
- 验证 AnkiConnect URL 是否正确(默认:http://localhost:8765)。
AnkiConnect 权限问题
当服务器尝试添加卡片时,AnkiConnect 可能会提示权限请求。请确保允许相关权限。
通过以上步骤,您可以使用此 MCP 服务器与 Anki 实现 LLM 交互功能。
扫码联系在线客服