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 许可证。