com.htmlradar/share

Attaches one file to a document already on HTMLRadar, for readers of its links to download. The file types are the website's (PDF, Office documents, images, CSV, text, Markdown, ZIP) and a document holds up to 20 files. The file travels as base64 in `content_base64`, because a tool argument is JSON, so it can be at most 5.0 MB, the same limit as publishing a page this way; a larger file (the website takes 25 MB) is added on the website. Readers see the file from the next time they load the page. There is no file-path argument: a file on disk reaches this tool only as content the caller has already read.

Creates an additional tracked link for a document already on HTMLRadar, with its own recipient label, gate, password, expiry and address. One link per recipient is what separates their reading reports. It uploads nothing and creates no second copy of the document, and it cannot publish new markup: it takes a document id, which list_shares returns and share_html returned when the document was first published. The link is live the moment it is returned. The answer includes the saved rules and comments state.

Returns the current contents of a document on HTMLRadar so they can be changed and put back with replace_document. Each image embedded as a data URI appears as a short htmlradar-image reference instead of its data; keep references exactly as they are. A page over 5 MB of text even with its images as references is too large to read whole; with `query`, a word or phrase from the part to change, any page returns only the passages where that text appears, which replace_document `edits` can then change. It reads only this account's documents and changes nothing.

Returns HTMLRadar's guidelines for pages that read well on phones and give accurate section reading

Returns the reading records the HTMLRadar website exports as a spreadsheet, as CSV text: one row per section per read, with the link's label and address, the reader, whether their address was verified, when they opened it, how long they read, how far they scrolled, and their country and device where recorded. The sender's own previews and internal viewers are left out, as on the website. Pass `share_id` for one link; without it every link of the document is included. A very long answer is cut at a whole record and gives a `continue_from` value: call again with the same arguments and that value for the next rows, until it says it is every row. For a quick answer about who read one link, get_share_activity is shorter. It changes nothing.

Returns a tracked link's current settings, in the form update_share changes them: who can open it (the full allowed-domain and allowed-address lists), the email gate and its one-time code, whether a password is set (never the password), the end date, the copy lock, comments, the label, who the gate names, whether the sender is emailed on the first open, and the settings version. It reads one of this account's links and changes nothing. The answer includes the saved Rules line and the version used by expected_settings_version.

Reports whether a tracked HTMLRadar link has been opened, by whom, for how long, how far they scrolled, and which sections held their attention. Per viewer it names the all recorded sections, ordered by reading time. Reading times are rounded down; scroll percentages are rounded to the nearest whole percent. It accepts a share id, a slug or a link; list_shares returns all three.

Lists the files attached to a document on HTMLRadar (supporting materials a reader can download beside the page): the file name, its size and the attachment id that remove_attachment takes. It returns no file contents and changes nothing. Call it before add_attachment or remove_attachment, and after an add that failed without an answer.

Lists the account's documents, newest first: the title, when it was created, how many tracked links point at it, and the document id that create_share and replace_document take. A document with no links appears here and nowhere else, because list_shares only knows documents that have been sent. It returns no document contents. Returns at most 50 per call; the `before` cursor pages back through older documents.

Lists the account's tracked links, newest first: the slug, the recipient label, the document title, whether it has been opened and when, and the share and document ids the other tools take. This is where the identifiers for a link made in an earlier conversation come from. The `opened` and `last_open` fields answer "which of my links has nobody opened" on their own, without a get_share_activity report for each one. Returns at most 50 per call; the `before` cursor pages back through older links.

Removes one attached file from a document. Readers lose the download from the next time they load the page. It removes the file only: the page, its links and its reading history are untouched, and there is no tool that deletes a page or a link. Claude cannot restore it, and it cannot be recovered from HTMLRadar, so attach it again from the original if the user changes their mind. Take the attachment id from list_attachments.

Replaces the contents of a document already on HTMLRadar. Every existing link stays exactly as it is — same address, same settings, same reading history — and serves the new contents from the next time it is opened, so nobody is sent a second link. The new HTML is screened for phishing signals as every upload is, and the previous version stays listed in the document's version history on the website. Restoring an earlier version is not available, from Claude or on the website; to go back, replace the contents again with the earlier page. Recipients may already have read the old contents. Pass either the whole new page in `html`, or `edits`: pieces of text to find in the page get_document returned, each with its replacement and each appearing exactly once. Edits suit small changes to a large page, because only the changes travel. Images that need a login, expiring image addresses and local file paths do not load for readers of the link. Images embedded in the HTML as data URIs always do. On an update, get_document shows each embedded image as a short htmlradar-image reference; keep each one exactly as it is and HTMLRadar puts the image back, so only new images count towards the 5 MB limit.

Switches off a tracked link that has already been sent. Anyone who opens it afterwards sees that it is no longer available, and the sender is emailed that somebody tried. This changes what a recipient can see. It is reversible — `revoked: false` switches the link back on, so use this tool to turn a switched-off link on again — and it deletes nothing: the link, its settings and its whole reading history survive. Deleting a link is possible only on the website, because it deletes its reading records for good. To change a link's settings, use update_share on the same link: switching one off to make a replacement leaves the recipient holding a dead address.

Publishes an HTML document — a deck, report, dashboard, proposal or one-pager — as a tracked HTMLRadar link, and returns two addresses: the link for the recipient, and a dashboard address for the sender. The recipient sees the document as written and never the tracking. The markup goes in `html`; there is no file-path argument, so a document on disk reaches this tool only as markup the caller has already read, which leaves the user's permissions on their own file tools in charge of what is published. By default the recipient is asked for their email address before the document opens, which is a step the person receiving the link has to take. The link is live the moment it is returned. The answer includes the saved rules and comments state. Images that need a login, expiring image addresses and local file paths do not load for readers of the link. Images embedded in the HTML as data URIs always do. On an update, get_document shows each embedded image as a short htmlradar-image reference; keep each one exactly as it is and HTMLRadar puts the image back, so only new images count towards the 5 MB limit.

Changes the settings of a tracked link that has already been sent, on the same link: who can open it (allowed domains and addresses), the email gate and its one-time code, the password, the end date, the copy lock, the label, who the gate names and whether the sender is emailed on the first open. Comments can be on or off; enabling needs a code-confirmed email gate. The answer includes the saved Rules line. The link, its address and its whole reading history stay the same. Only the settings you name change; every other setting is left as it is, and a setting is removed only when it is named in `clear`. The list arguments add_allowed_emails, remove_allowed_emails, add_allowed_email_domains and remove_allowed_email_domains: the server merges them over the stored list and says what was added, removed and not found. Sending allowed_emails or allowed_email_domains replaces the whole list and needs expected_settings_version from get_share, so a change made since is never overwritten. A stale version is refused without saving. A change applies from the next time the page is loaded: someone reading it right now keeps the page they have until they reload. If the sender is on a company team, the team's rules apply to this change exactly as on the website (for example a required one-time code or company domains), and a change that breaks one is refused with the rule named. Narrowing who can open a link, or removing a list, changes what recipients can see.

Reports which HTMLRadar account the API key belongs to (its email address), the plan it is on and how many of its free tracked links remain.