Readwise

🚀 Readwise MCP サーバー

このサーバーは、Model Context Protocol (MCP) を使用して、Readwise ライブラリへのアクセスと相互作用を可能にします。MCP プロトコルを介してデータとやり取りし、情報の処理と分析を支援するための様々な機能を提供します。

🚀 クイックスタート

この Readwise MCP サーバーを使用することで、Readwise ライブラリにアクセスし、様々な操作を行うことができます。以下のセクションでは、機能、インストール、設定、使用方法などについて詳しく説明します。

✨ 主な機能

• ハイライトの取得：Readwise ライブラリからハイライト内容を取得します。
• ハイライトの検索：Readwise ライブラリ内でハイライト内容を検索します。
• 書籍情報の取得：Readwise ライブラリから書籍情報を取得します。
• ドキュメント情報の取得：Readwise ライブラリからドキュメント情報を取得します。

📦 インストール

以下の方法でプロジェクトをインストールできます。

方法1：npm からインストール

npm install readwise-mcp-server

方法2：リポジトリをクローンして依存関係をインストール

1. リポジトリをクローンします：

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

2. 依存関係をインストールします：

   npm install
   

🔧 設定

方法1：設定ウィザードを実行

npm run setup

方法2：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();

📚 ドキュメント

プロジェクト構造

プロジェクトは以下の主要部分に分かれています。

• src：サーバーの核心実装を含むメインコードベースです。
• test-scripts：自動テストと機能検証に使用されるテストスクリプトです。
• examples：MCP サーバーの使用方法を示すサンプルコードです。
• dist：コンパイル後のファイルを含むビルド出力ディレクトリです。
• scripts：起動スクリプトやその他の開発ツールです。

テスト

自動テスト

以下のコマンドを実行してすべてのテストを実行できます。

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 の下でライセンスされています。