Anki MCP Server 使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 的服务器,旨在将 Anki 知识库集成到支持 MCP 协议的 LLM 客户端(如 Claude Desktop)中。通过 AnkiConnect 插件,该服务器能够以资源和工具的形式,让 LLM 客户端访问和操作 Anki 中的牌组、模型和笔记,从而扩展 LLM 的知识范围和交互能力。

主要功能点

  • 资源访问 (Resources)
    • 列出和访问 Anki 牌组(Decks),每个牌组以 'anki://decks/{id}' 格式的 URI 标识。
    • 列出和访问 Anki 模型(Note Models),每个模型以 'anki://models/{id}' 格式的 URI 标识。
    • 以 JSON 格式提供 Anki 牌组和模型的详细信息。
  • 工具调用 (Tools)
    • 'listDecks': 获取 Anki 中所有牌组的名称列表。
    • 'listModels': 获取 Anki 中所有模型(Note Model)的名称列表。
    • 'getModel': 获取指定模型的详细信息,包括字段和模板定义。
    • 'addNote': 在 Anki 中创建单个笔记,可以指定牌组、模型、字段内容和标签。
    • 'addNotes': 在 Anki 中批量创建多个笔记。

安装步骤

  1. 安装 Node.js 和 npm: 确保你的电脑上安装了 Node.js 和 npm (Node Package Manager)。
  2. 克隆仓库: 将 GitHub 仓库 'https://github.com/CamdenClark/anki-mcp-server' 克隆到本地。
    git clone https://github.com/CamdenClark/anki-mcp-server
    cd anki-mcp-server
  3. 安装依赖: 在仓库根目录下运行以下命令安装项目依赖。
    npm install
  4. 构建项目: 运行以下命令构建 TypeScript 代码。
    npm run build
    构建成功后,会在 'build' 目录下生成 'index.js' 文件,这是服务器的入口文件。

服务器配置

要将 Anki MCP Server 集成到 MCP 客户端(例如 Claude Desktop),需要配置 MCP 服务器信息。以 Claude Desktop 为例,你需要编辑配置文件 'claude_desktop_config.json'。

配置文件路径:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容示例:

在 'claude_desktop_config.json' 文件中,找到或创建 'mcpServers' 字段,并添加以下配置信息。你需要将 '/path/to/anki-mcp/build/index.js' 替换为 'build/index.js' 文件的绝对路径

{
  "mcpServers": {
    "anki-mcp": {
      "command": "/path/to/anki-mcp/build/index.js"  //  请替换为 build/index.js 文件的绝对路径,例如: "/Users/你的用户名/anki-mcp-server/build/index.js"
    }
  }
}

注意: 'command' 字段需要配置为 'index.js' 文件的绝对路径。你可以通过在终端中进入 'build' 目录并运行 'pwd' 命令来获取当前目录的绝对路径,然后手动拼接上 'index.js'。

基本使用方法

  1. 启动 Anki 和 AnkiConnect 插件: 确保你的 Anki 应用已经启动,并且安装并启用了 AnkiConnect 插件。AnkiConnect 默认监听 'http://localhost:8765'。
  2. 启动 Anki MCP Server: 在仓库根目录下,运行以下命令启动 MCP 服务器。
    npm run start
    或者直接运行构建后的 'index.js' 文件:
    node build/index.js
    服务器启动后,将通过标准输入/输出 (stdio) 与 MCP 客户端通信。
  3. 配置并启动 MCP 客户端: 根据 MCP 客户端(例如 Claude Desktop)的文档,配置并启用 'anki-mcp' 服务器。客户端应该能够自动连接到运行中的 MCP 服务器。
  4. 在 MCP 客户端中使用 Anki 功能: 在 MCP 客户端中,你可以指示 LLM 使用 'anki-mcp' 服务器提供的工具来访问和操作 Anki 知识库。例如,你可以让 LLM 列出你的牌组,查询特定模型的信息,或者创建新的笔记。

调试: 如果需要调试 MCP 服务器,可以使用 MCP Inspector。按照 README 中的说明运行 'npm run inspector' 启动 Inspector,并通过浏览器访问提供的 URL 进行调试。

信息

分类

生产力应用