Readwise-Reader-MCP by SrideviGopukumar - MCP Server

Readwise Reader MCP Server - A TypeScript API Solution

Overview

The Readwise Reader MCP Server is a Model Context Protocol (MCP) server designed for the Readwise Reader API. This server is built using TypeScript and the official Claude SDK, offering a robust solution for managing your reading materials efficiently.

Features

Secure Authentication

The server employs secure authentication by utilizing environment variables for token storage. This ensures that sensitive information remains protected.

Document Management

You can save, list, update, and delete documents while retaining complete metadata. This feature allows you to manage your reading materials with ease.

Tag Management

Easily list and filter documents by tags. This helps in organizing your content effectively, making it simple to find what you need.

Rich Filtering

Filter documents based on various criteria such as location, category, and tags. This feature enhances your ability to navigate through large collections of documents.

Pagination Support

The server supports pagination, allowing you to handle large document collections without performance issues. This ensures a smooth user experience.

LLM-Friendly Content

The server automatically converts HTML content to clean text using r.jina.ai. This feature makes the content more accessible and easier to read.

Complete Data Access

The server returns full document information, including content, metadata, and timestamps. This comprehensive data access ensures that you have all the information you need at your fingertips.

API Documentation

For detailed information about the Readwise Reader API endpoints, parameters, and examples, please refer to the official API documentation:

📖 Readwise Reader API Documentation

This MCP server implements all the core endpoints described in the official documentation, ensuring that you can utilize the API effectively.

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

Node.js (version 14 or higher)
npm (Node Package Manager)

Installation

Clone the repository:

git clone https://github.com/SrideviGopukumar/Readwise-Reader-MCP.git

Navigate to the project directory:
```
cd Readwise-Reader-MCP
```
Install the dependencies:
```
npm install
```
Set up environment variables. Create a .env file in the root directory and add your API token:
```
READWISE_API_TOKEN=your_api_token_here
```
Start the server:
```
npm start
```

Usage

Once the server is running, you can interact with the API using tools like Postman or curl. Here are some example requests:

Get All Documents

GET /documents

Create a New Document

POST /documents
Content-Type: application/json

{
  "title": "Your Document Title",
  "content": "The content of your document.",
  "tags": ["tag1", "tag2"]
}

Update a Document

PUT /documents/{id}
Content-Type: application/json

{
  "title": "Updated Title",
  "content": "Updated content."
}

Delete a Document

DELETE /documents/{id}

Contributing

Contributions are welcome! If you have suggestions or improvements, feel free to open an issue or submit a pull request.

Steps to Contribute

Fork the repository.

Create a new branch for your feature or fix:

git checkout -b feature/your-feature-name

Make your changes and commit them:

git commit -m "Add your commit message"

Push to your branch:

git push origin feature/your-feature-name

Open a pull request.

Testing

To ensure the server works as expected, run the tests included in the repository:

npm test

This command will execute the test suite and report any failures or errors.

Release Notes

For information on the latest releases, please visit the Releases section. Here you will find details on new features, bug fixes, and improvements.

License

This project is licensed under the MIT License. See the file for details.

Acknowledgments

Thanks to the Readwise team for providing the API.
Special thanks to the developers of the Claude SDK for their support.

Contact

For any inquiries, please reach out via the GitHub issues page or directly through the repository.

Additional Resources

For further reading and resources related to the Readwise Reader API, check out the following links:

Support

If you encounter any issues or need assistance, feel free to check the Releases section for updates or raise an issue in the repository.

Conclusion

This Readwise Reader MCP Server provides a reliable and efficient way to manage your reading materials. With its rich features and straightforward API, you can enhance your reading experience.