Skip to content

Add tags support to document updates and update API schemas#4

Open
vinothpandian wants to merge 3 commits into
edricgsh:mainfrom
vinothpandian:main
Open

Add tags support to document updates and update API schemas#4
vinothpandian wants to merge 3 commits into
edricgsh:mainfrom
vinothpandian:main

Conversation

@vinothpandian

@vinothpandian vinothpandian commented Sep 13, 2025

Copy link
Copy Markdown

Fixes #5

Summary

  • Add tags support to document update operations
  • Fix tag response format to match current API specification
  • Update category and location enums to reflect latest API changes

Changes Made

  • Tags Support: Added tags parameter to UpdateDocumentRequest interface and readwise_update_document tool schema
  • Tag Format Fix: Updated ReadwiseTag interface to use key field instead of id to match API response format
  • Category Updates:
    • Removed deprecated categories: book, youtube, podcast
    • Added new categories: rss, highlight, note, epub
  • Location Constraints: Removed shortlist from update location enum (not supported by update endpoint)
  • Documentation: Updated README.md to reflect API changes and limitations

API Reference

Changes based on the official Readwise Reader API documentation: https://readwise.io/reader_api

Updated on: 2025-09-12

Breaking Changes

  • ReadwiseTag.id field renamed to ReadwiseTag.key
  • Some category values no longer supported in favor of new API categories
  • Document updates no longer support shortlist location (filtering still supports it)

vinothpandian and others added 3 commits September 12, 2025 22:14
- Add tags parameter to UpdateDocumentRequest interface
- Update ReadwiseTag interface to use 'key' instead of 'id' field
- Update category enums across all interfaces to match current API
  - Remove deprecated: book, youtube, podcast
  - Add new categories: rss, highlight, note, epub
- Remove shortlist from update location enum (not supported by API)
- Add tags parameter to readwise_update_document tool schema
- Update documentation to reflect API changes and limitations
- Fix listTags to handle paginated API response (was assuming array)
- Add missing parameters to save_document: should_clean_html, title,
  author, summary, published_date, image_url, saved_using, notes
- Add missing 'seen' parameter to update_document
- Add withRawSourceUrl parameter to list_documents
- Add reading_time and raw_source_url to ReadwiseDocument type
- Remove 'shortlist' from CREATE location enum (only valid for LIST)
- Update CLAUDE.md to reference API docs file
- Add local copy of Readwise Reader API documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add readwise_update_document_tags for single document tag updates
- Add readwise_bulk_update_tags for bulk tag operations
- Both tools support "replace" (default) and "add" modes
- Remove readwise_delete_document tool and related code

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing tags support in document updates - Readwise Reader API changes

1 participant