Captain Blue210 Anki MCP Server

🚀 Anki MCP 服務器

Anki MCP 服務器是專為 Claude Desktop 設計的 Model Context Protocol (MCP) 服務器。它藉助 AnkiConnect 與 Anki 相連，能檢索帶有“leech”標籤的卡片，為 Claude 提供豐富的卡片數據用於分析。

✨ 主要特性

• 通過 AnkiConnect API 與 Anki 建立連接。
• 檢索帶有“leech”標籤的卡片。
• 在卡片上添加帶有日期戳記的複習標籤。
• 提供全面的卡片數據，便於 Claude 進行分析。
• 可與 Claude Desktop 協同使用。

📦 安裝指南

先決條件

• 安裝並運行 Anki。
• 在 Anki 中安裝 AnkiConnect 插件。
• 安裝 Node.js 和 npm。

安裝步驟

1. 克隆此倉庫：

   git clone https://github.com/yourusername/anki-mcp-server.git
   cd anki-mcp-server
   

2. 安裝依賴項：

   npm install
   

3. 構建項目：

   npm run build
   

🔧 配置

服務器可通過環境變量進行配置。複製提供的示例文件以創建自己的配置：

cp .env.example .env

環境變量說明

💻 使用示例

基礎用法

const { AnkiMCP } = require('anki-mcp');

// 初始化 MCP 服務器
const mcp = new AnkiMCP({
  connectUrl: process.env.ANKI_CONNECT_URL,
  mockMode: process.env.ANKI_MOCK_MODE === 'true'
});

// 獲取所有 leech 卡片
async function getLeechCards() {
  try {
    const cards = await mcp.getLeechCards();
    console.log('獲取到的 leech 卡片:', cards);
  } catch (error) {
    console.error('獲取卡片時出錯:', error.message);
  }
}

// 在卡片上添加複習標籤
async function addReviewTag(cardId, customPrefix = '見直し') {
  try {
    await mcp.addReviewTag(cardId, customPrefix);
    console.log('已為卡片', cardId, '添加複習標籤');
  } catch (error) {
    console.error('添加標籤時出錯:', error.message);
  }
}

// 啟動服務器
async function startServer() {
  try {
    await mcp.start();
    console.log('MCP 服務器已啟動並正在監聽...');
  } catch (error) {
    console.error('啟動服務器失敗:', error.message);
  }
}

使用說明

1. 創建 .env 文件

在項目根目錄下創建 .env 文件，並添加上述環境變量。例如：

ANKI_CONNECT_URL=http://localhost:8765
ANKI_MOCK_MODE=false

2. 啟動服務器

運行以下命令啟動服務器：

npm start

功能說明

• 檢索卡片：通過調用 getLeechCards 方法獲取所有帶有“leech”標籤的卡片。
• 添加複習標籤：使用 addReviewTag 方法在指定卡片上添加日期戳記的複習標籤。

📚 詳細文檔

問題排查

• 無法連接到 Anki：請確保 Anki 已運行且 AnkiConnect 插件正常安裝。
• 沒有找到 leech 卡片：您在 Anki 中沒有任何帶有“leech”標籤的卡片。
• localhost 連接問題：若使用 localhost 無法連接，請：
  1. 查找您的本地 IP 地址（如 192.168.x.x 或 10.x.x.x）。
  2. 更新 .env 文件，設置 ANKI_CONNECT_URL=http://YOUR_LOCAL_IP:8765。
  3. 確保 AnkiConnect 允許來自該 IP 的連接。
  4. 修改後重啟 MCP 服務器。

測試模式

為了在不更改實際數據的情況下進行測試，請使用 mock 模式：

1. 在 .env 文件中設置 ANKI_MOCK_MODE=true 或使用提供的 .env.test 文件。
2. 使用以下命令啟動服務器：

   npm run start:test
   

開發模式

要在開發過程中啟用熱重載：

npm run dev

對於 mock 模式的開發，請運行：

npm run dev:test

📄 許可證

本項目採用 MIT 許可證。