使用说明
项目简介
Readwise MCP服务器 ('Kiseki-Labs-Readwise-MCP') 是一个实现了 Model Context Protocol (MCP) 的服务器,它专注于将您的 Readwise 数据(文档和高亮)以结构化的方式提供给大型语言模型 (LLM) 客户端使用。通过该服务器,LLM 可以调用预设的工具来检索和操作您的 Readwise 数据,从而实现更智能的知识管理和应用场景。
主要功能点
- 连接 Readwise API: 服务器作为桥梁,连接 Readwise API,让 LLM 客户端无需直接处理 API 细节,即可安全访问您的 Readwise 数据。
- 文档检索工具: 提供工具让 LLM 可以根据文档名称或筛选条件(如分类、日期范围)查找 Readwise 中的文档。
- 高亮检索工具: 提供工具让 LLM 可以根据文档 ID 或筛选条件(如日期范围、标签)查找 Readwise 文档中的高亮内容。
- 资源访问: 通过定义的资源路径 (例如 'greeting://{name}'),可以提供动态生成的内容,为 LLM 提供更灵活的上下文信息。
- 易于集成: 遵循 MCP 协议,可以方便地与支持 MCP 协议的 LLM 客户端(如 Claude)集成。
安装步骤
-
克隆仓库:
git clone https://github.com/kiseki-technologies/kiseki-labs-readwise-mcp cd kiseki-labs-readwise-mcp -
初始化依赖: 确保您已安装 uv。然后运行:
uv sync -
配置 Readwise API 密钥:
- 访问 Readwise 令牌页面 获取您的 API 密钥。
- 在项目根目录下创建 '.env' 文件。
- 将您的 API 密钥添加到 '.env' 文件中,例如:
READWISE_API_KEY=YOUR_READWISE_API_KEY
服务器配置
要将 Readwise MCP 服务器配置到 MCP 客户端 (例如 Claude),您需要提供服务器的启动命令和参数。以下是针对 Claude 客户端的配置示例,您需要将其添加到 Claude 的配置文件中。
Claude 客户端 MCP 服务器配置 (JSON 格式):
{ "serverName": "Kiseki-Labs-Readwise-MCP", "command": "/Users/eddie/.pyenv/shims/uv", "args": [ "run", "--with", "fastmcp", "fastmcp", "run", "/Users/eddie/Development/AI/mcp_servers/readwise_mcp/server.py" ] }
参数说明:
- serverName: MCP 服务器的名称,在客户端中用于标识和选择该服务器,例如 '"Kiseki-Labs-Readwise-MCP"'。
- command: 启动 MCP 服务器的命令。通常是 Python 解释器或包管理器(如 'uv'),例如 '"/Users/eddie/.pyenv/shims/uv"'。请根据您的 Python 环境和 'uv' 的安装路径进行调整。
- args: 传递给启动命令的参数列表,用于执行服务器代码。
- '"run"': 'uv run' 命令的子命令,用于运行 Python 脚本。
- '"--with"': 指定要加载的插件或扩展,这里使用 '"fastmcp"',表示启用 'fastmcp' 框架。
- '"fastmcp"': 'fastmcp' 插件的名称。
- '"run"': 'fastmcp run' 命令,用于启动 MCP 服务器。
- '"/Users/eddie/Development/AI/mcp_servers/readwise_mcp/server.py"': 服务器主程序 'server.py' 的绝对路径。请务必替换为您实际的 'server.py' 文件路径。
配置步骤 (以 Claude 为例):
- 打开 Claude 的配置文件 '~/Library/Application\ Support/Claude/claude_desktop_config.json'。
- 在 'mcpServers' 对象下添加上述 JSON 配置。
- 保存配置文件并重启 Claude 客户端。
基本使用方法
配置完成后,在支持 MCP 协议的 LLM 客户端中,您应该能够选择并连接到 "Kiseki-Labs-Readwise-MCP" 服务器。之后,您可以通过客户端的界面或指令,调用服务器提供的工具来访问您的 Readwise 数据。
例如,您可以指示 LLM 使用 'find_readwise_document_by_name' 工具来查找特定的文档,或者使用 'get_readwise_highlights_by_filters' 工具来检索特定标签或日期范围的高亮内容。
具体的工具调用方式取决于 LLM 客户端的实现,但通常您可以使用自然语言指令来触发工具的执行。
注意: 此服务器主要提供数据访问能力,Prompt 模板可能需要在 LLM 客户端或应用层进行定义和管理。
信息
分类
AI与计算