Readwise MCP

🚀 Readwise MCP 服務器

Readwise MCP 服務器是一個基於模型上下文協議（MCP）的工具，可用於訪問和交互您的 Readwise 圖書館。它支持對高亮內容的查詢、書籍和文檔資料的獲取，還能對高亮內容進行搜索和處理。

🚀 快速開始

本項目允許你通過命令行工具或 API 與 Readwise 圖書館進行交互。你可以輕鬆獲取高亮內容、書籍信息和文檔資料，還能使用自然語言查詢搜索高亮內容。

✨ 主要特性

• 🔍 訪問您在 Readwise 中的高亮內容
• 🗣️ 使用自然語言查詢搜索高亮內容
• 📚 獲取您在 Readwise 中的書籍信息
• 📄 獲取您在 Readwise 中的文檔資料
• 🛠️ 搜索並處理來自 Readwise 的高亮內容，支持摘要、分析、關聯查找和問題生成

📦 安裝指南

1. 克隆倉庫

   git clone https://github.com/your-repository.git
   cd your-repository
   

2. 安裝依賴項

   npm install
   

3. 構建項目

   npm run build
   

🛠️ 配置設置

1. 運行設置嚮導

   npm run setup
   

2. 配置 API 密鑰
   • 打開 config.js 文件
   • 在其中添加您的 Readwise API 密鑰
   • 保存文件

💻 使用示例

CLI 使用示例

# 獲取高亮內容
npm run get-highlights -- [--page=1 --limit=10]

# 搜索高亮內容
npm run search-highlights -- [--query="您的搜索詞" --exact]

API 示例代碼

const { MCPClient } = require('@readwise/mcp-client');

// 初始化客戶端
const client = new MCPClient('your-api-key');

// 獲取高亮內容
async function getHighlights() {
    try {
        const response = await client.getHighlights({
            page: 1,
            limit: 10
        });
        console.log(response.data);
    } catch (error) {
        console.error('獲取高亮內容失敗:', error.message);
    }
}

// 搜索高亮內容
async function searchHighlights() {
    try {
        const response = await client.searchHighlights({
            query: '您的搜索詞',
            exact: true
        });
        console.log(response.data);
    } catch (error) {
        console.error('搜索高亮失敗:', error.message);
    }
}

🧪 測試方法

1. 運行自動化測試

   npm test
   

2. 手動測試工具
   • 使用 get_highlights 工具獲取高亮內容
   • 使用 search_highlights 工具搜索高亮內容
3. 使用 Mock 測試環境

   npm run test-mock
   

🛠️ 可用工具

• get_highlights：獲取您的 Readwise 圖書館中的高亮內容
• get_books：獲取您在 Readwise 中的書籍信息
• get_documents：獲取您在 Readwise 中的文檔資料
• search_highlights：在您的 Readwise 圖書館中搜索高亮內容

💡 可用提示

readwise_highlight

• 處理來自 Readwise 的高亮內容，支持摘要、分析、關聯查找和問題生成
• 具有強大的錯誤處理和參數驗證
• 提供讀者友好的格式化高亮內容

readwise_search

• 搜索並處理來自 Readwise 的高亮內容
• 提供格式化的搜索結果，包括來源信息
• 平滑處理 API 錯誤，並提供用戶友好的消息
• 包括對必需參數的驗證

🌟 最近改進

增強 MCP 協議兼容性

• 正確處理所有響應中的 request_id
• 驗證入站請求以符合 MCP 協議規範
• 維護一致且符合 MCP 指南的錯誤響應格式

改進設置體驗

• 提供交互式設置嚮導
• 安全存儲配置信息
• 提供詳細的錯誤消息用於故障排除

健壯的錯誤處理機制

• 針對不同的 API 錯誤情況提供具體錯誤消息
• 在所有工具和提示中保持一致的錯誤格式
• 運輸感知日誌記錄，不干擾協議流程

🛠️ 開發信息

# 構建項目
npm run build

# 執行測試
npm test

# 開發模式啟動（自動重載）
npm run dev:watch

# 代碼檢查
npm run lint

📄 許可證

MIT

📁 項目結構

# 主代碼目錄
src/

# 測試腳本目錄
test-scripts/

# 文檔目錄
docs/

# 示例配置文件目錄
examples/