docs: document Google API limitations and improve error messages#26
Merged
a-bonus merged 1 commit intoa-bonus:mainfrom Nov 29, 2025
Merged
docs: document Google API limitations and improve error messages#26a-bonus merged 1 commit intoa-bonus:mainfrom
a-bonus merged 1 commit intoa-bonus:mainfrom
Conversation
- Add 'Known Limitations' section to README documenting: - Comment anchoring limitations (Drive API v3) - Comment resolution limitations - Converted document limitations - Update addComment tool description to explain anchoring limitation - Update resolveComment tool description to explain persistence limitation - Improve readGoogleDoc error messages with detailed API error info
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents known Google API limitations and improves error messages to help users understand and troubleshoot issues. These limitations are inherent to Google's APIs, not bugs in our implementation.
Changes
README Updates
Added "Known Limitations" section documenting:
addCommenttool appear in "All Comments" list but are not visibly anchored to text in the UI (shows "original content deleted"). This is a Drive API v3 limitation.resolveCommenttool attempts to mark comments as resolved, but the status may not persist in Google Docs UI due to Drive API v3 limitations.Tool Description Updates
addCommentdescription to explain anchoring limitationresolveCommentdescription to explain persistence limitation and recommend manual resolution when neededError Message Improvements
Enhanced
readGoogleDocerror handling:Testing
Non-Breaking Changes
✅ Documentation and error message improvements only - no behavior changes