Readwise

🚀 Readwise MCP 服務器

Readwise MCP 服務器是一個基於 Model Context Protocol (MCP) 的工具，可讓你輕鬆訪問並與 Readwise 圖書館進行交互，提供了豐富的功能來處理和分析信息。

🚀 快速開始

Readwise MCP 服務器允許你通過 MCP 協議與 Readwise 圖書館的數據進行交互。你可以使用它獲取高亮、搜索高亮、獲取書籍和文檔信息等。

✨ 主要特性

• 獲取高亮：從您的 Readwise 圖書館中獲取高亮內容。
• 搜索高亮：在您的 Readwise 圖書館中搜索高亮內容。
• 獲取書籍：從您的 Readwise 圖書館中獲取書籍信息。
• 獲取文檔：從您的 Readwise 圖書館中獲取文檔信息。

📦 安裝指南

方式一：從 npm 安裝

npm install readwise-mcp-server

方式二：克隆倉庫並安裝依賴

1. 克隆倉庫：

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

2. 安裝依賴：

   npm install
   

📚 詳細文檔

配置

方式一：運行設置嚮導

npm run setup

方式二：直接使用 API 密鑰

1. 確保您有一個有效的 Readwise API 密鑰。
2. 啟動服務器：

   npm start -- --apiKey your_api_key_here
   

使用方法

命令行界面 (CLI)

• 啟動服務器（默認模式）：

  npm start
  

• 啟動服務器（開發模式）：

  npm run dev
  

• 指定 API 密鑰：

  npm start -- --apiKey your_api_key_here
  

• 啟用調試模式：

  npm start -- --debug
  

程序員接口 (API)

const { MCPServer } = require('readwise-mcp-server');

// 創建服務器實例
const server = new MCPServer({
  apiKey: 'your_api_key_here'
});

// 啟動服務器
server.start();

測試

自動化測試

運行以下命令以執行所有測試：

npm test

使用 MCP 檢查器進行測試

1. 安裝檢查工具：

   npm install mcp-inspector
   

2. 啟動服務器並使用檢查工具連接。

無 API 密鑰的測試

如果您沒有 API 密鑰或不想使用實際密鑰進行測試，可以運行以下命令：

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 協議規範
• 維持一致且符合標準的錯誤響應格式

開發人員體驗提升

• 改進了調試信息的輸出
• 簡化了配置流程
• 增加了詳細的文檔和示例

開發

本地開發

1. 克隆倉庫：

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

2. 安裝依賴：

   npm install
   

3. 啟動開發服務器：

   npm run dev
   

貢獻指南

• 請參考項目倉庫中的貢獻指南。

項目結構

項目分為以下幾個主要部分：

📄 許可證

該項目使用 MIT License 許可證。