项目简介

Readwise MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在帮助 LLM 客户端以标准化的方式访问和操作您的 Readwise 知识库。通过此服务器,您可以轻松地将 Readwise 中积累的知识和信息整合到各种 LLM 应用中,例如智能助手、知识检索工具等。

主要功能点

  • 访问 Readwise 资源: 轻松获取您在 Readwise 中保存的书籍、文章、高亮标注和文档。
  • 自然语言搜索: 使用自然语言查询在您的 Readwise 高亮标注中进行搜索,快速定位所需信息。
  • Prompt 模板: 内置 Prompt 模板,支持对 Readwise 高亮标注进行摘要、分析、关联分析和问题生成等多种任务。
  • 工具集成: 提供工具 (Tools) 注册和执行能力,允许 LLM 客户端调用预定义的功能,例如获取书籍列表、高亮标注列表、文档列表和搜索高亮标注。
  • 多传输协议支持: 支持 Stdio 和 SSE (Server-Sent Events) 传输协议,兼容 Claude 等 MCP 客户端以及 Web 应用集成。
  • 完善的错误处理: 具备强大的错误处理机制和请求验证,确保服务器稳定可靠运行。
  • 便捷安装与配置: 提供简单的 CLI 安装方式和 Setup 向导,API Key 配置方便快捷。

安装步骤

  1. 安装 Node.js 和 npm: 确保您的系统中已安装 Node.js 和 npm。

  2. 全局安装 'readwise-mcp': 打开终端,运行以下命令进行全局安装:

    npm install -g readwise-mcp

    或者,您也可以克隆仓库并本地安装:

    git clone https://github.com/IAmAlexander/readwise-mcp.git
    cd readwise-mcp
    npm install
    npm run build

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令 (command) 及其参数 (args) 才能建立连接。以下是 'readwise-mcp' 服务器的典型配置信息,请根据您使用的客户端进行相应配置:

{
  "serverName": "Readwise MCP Server",
  "command": "readwise-mcp",
  "args": [],
  "transport": "stdio"
}

参数注释:

  • '"serverName"': MCP 服务器的名称,可以自定义。
  • '"command"': 启动 'readwise-mcp' 服务器的命令,通常为 'readwise-mcp'。
  • '"args"': 启动命令的参数,默认为空数组 '[]',表示使用 Stdio 传输协议。
  • '"transport"': 传输协议类型,默认为 '"stdio"'。如果需要使用 SSE 协议,请修改 '"args"' 为 '["--transport", "sse", "--port", "3000"]',并确保 MCP 客户端支持 SSE 协议。

SSE 传输协议配置示例:

{
  "serverName": "Readwise MCP Server (SSE)",
  "command": "readwise-mcp",
  "args": ["--transport", "sse", "--port", "3000"],
  "transport": "sse"
}

注意: 启动 SSE 协议时,请确保防火墙允许端口 '3000' 的网络连接。

基本使用方法

  1. 配置 Readwise API Key: 首次运行服务器前,您需要配置 Readwise API Key。运行以下命令启动 Setup 向导:

    readwise-mcp --setup

    按照提示输入您的 Readwise API Key。您也可以直接通过参数启动服务器并指定 API Key:

    readwise-mcp --api-key YOUR_API_KEY

    您的 API Key 可在 https://readwise.io/access_token 获取。

  2. 启动服务器: 配置 API Key 后,即可启动服务器。

    • 默认启动 (Stdio 传输): 适用于 Claude 等桌面客户端:

      readwise-mcp
    • SSE 传输启动: 适用于 Web 应用集成,需指定端口:

      readwise-mcp --transport sse --port 3000
  3. 连接 MCP 客户端: 在您的 MCP 客户端中,配置服务器连接信息(如上文 "服务器配置" 所示),客户端将自动与 'readwise-mcp' 服务器建立连接。

  4. 使用工具和 Prompt: 连接成功后,您可以在 MCP 客户端中使用以下工具 (Tools) 和 Prompt 模板 (Prompts) 与 Readwise 知识库进行交互:

    可用工具 (Tools):

    • 'get_highlights': 获取 Readwise 高亮标注列表
    • 'get_books': 获取 Readwise 书籍列表
    • 'get_documents': 获取 Readwise 文档列表
    • 'search_highlights': 搜索 Readwise 高亮标注
    • 'get_tags': 获取 Readwise 标签列表
    • 'document_tags': 管理文档标签 (获取、更新、添加、删除)
    • 'bulk_tags': 批量管理文档标签
    • 'get_reading_progress': 获取文档阅读进度
    • 'update_reading_progress': 更新文档阅读进度
    • 'get_reading_list': 获取阅读列表
    • 'create_highlight': 创建高亮标注
    • 'update_highlight': 更新高亮标注
    • 'delete_highlight': 删除高亮标注
    • 'create_note': 创建笔记
    • 'advanced_search': 高级搜索
    • 'search_by_tag': 按标签搜索
    • 'search_by_date': 按日期搜索

    可用 Prompt 模板 (Prompts):

    • 'readwise_highlight': 处理 Readwise 高亮标注 (摘要、分析等)
    • 'readwise_search': 搜索和处理 Readwise 高亮标注

    具体工具和 Prompt 的使用方法,请参考 MCP 客户端的文档。

开发和测试: 如果您是开发者,可以使用 'npm run dev' 命令在开发模式下启动服务器,或使用 'npm test' 命令运行测试。

信息

分类

生产力应用