使用说明
项目简介
Reader MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,它将您的 Readwise Reader 文档资源化,使得大型语言模型(LLM)可以通过标准化的 MCP 协议访问和利用您的个人阅读数据。通过此服务器,您可以构建能够理解和利用您个人知识库的 LLM 应用。
主要功能点
- 文档资源化: 将 Readwise Reader 中的文档以 MCP 资源的形式对外提供。
- 按位置筛选: 支持根据文档在 Reader 中的位置(如 new, later, archive 等)筛选文档。
- 按时间筛选: 支持根据文档最后修改时间筛选文档。
- JSON-RPC 接口: 遵循 MCP 协议,通过 JSON-RPC 与客户端进行通信。
安装步骤
- 环境准备: 确保您的系统已安装 Python 3.6 或更高版本。
- 安装依赖: 使用 pip 安装项目依赖。在仓库根目录下打开终端,运行命令:
或者,如果您已经下载了仓库代码,可以在仓库目录下直接安装:pip install python-dotenv httpx fastmcppip install . - 配置环境变量: 您需要设置 Readwise Reader 的 API 访问令牌。
- 前往 Readwise Reader 整合设置 获取您的 'READER_ACCESS_TOKEN'。
- 将 'READER_ACCESS_TOKEN' 设置为环境变量。例如,在 Linux 或 macOS 系统中,您可以编辑 '~/.bashrc' 或 '~/.zshrc' 文件,添加以下行并保存:
然后运行 'source ~/.bashrc' 或 'source ~/.zshrc' 使环境变量生效。在 Windows 系统中,您可以在系统环境变量中添加 'READER_ACCESS_TOKEN'。export READER_ACCESS_TOKEN="YOUR_READER_ACCESS_TOKEN"
服务器配置
MCP 客户端需要配置连接到 Reader MCP Server 的信息。以下是一个典型的 JSON 格式配置示例,您需要将其填入 MCP 客户端的服务器配置中:
{ "server_name": "reader-api", "command": "python", "args": ["main.py"], "transports": ["stdio"] }
配置参数说明:
- 'server_name': 服务器名称,这里设置为 "reader-api"。
- 'command': 启动服务器的命令,这里使用 'python' 解释器。
- 'args': 传递给启动命令的参数,这里指定运行 'main.py' 文件。
- 'transports': 服务器支持的传输协议,这里配置为 'stdio' (标准输入输出)。
请注意:
- 确保 MCP 客户端能够找到 'main.py' 文件。如果您的客户端工作目录与 'main.py' 不在同一目录,您可能需要调整 'args' 中的路径。
- 环境变量 'READER_ACCESS_TOKEN' 必须正确配置,服务器才能成功连接到 Readwise Reader API。
基本使用方法
-
启动服务器: 在仓库根目录下打开终端,运行命令:
python main.py服务器将开始监听 MCP 客户端的请求。
-
客户端请求资源: 在您的 MCP 客户端中,可以使用以下资源 URI 请求文档列表:
reader://documents/location={location};after={after}- '{location}': 替换为您想要查询的文档位置,例如 'new', 'later', 'archive' 等。
- '{after}': 替换为 ISO 8601 格式的日期时间字符串,用于筛选在该时间之后更新的文档。例如 '2023-10-26T10:00:00Z'。
示例请求 URI: 'reader://documents/location=new;after=2023-11-01T00:00:00Z' 将获取 "new" 位置下,2023年11月1日之后更新的文档列表。
-
查看响应: 服务器会将 Readwise Reader API 返回的文档数据以 JSON 格式响应给 MCP 客户端。客户端可以解析 JSON 响应,并根据需要提取文档信息。
通过 Reader MCP Server,您可以方便地将 Readwise Reader 中的文档集成到各种支持 MCP 协议的 LLM 应用中,构建更智能、更个性化的应用体验。
信息
分类
生产力应用