Share a document
tp_share_documentSets who can open a document and returns the sharing mode, URL and reader list. Use it when the user asks to share, publish or unshare a document, to make it private, or to add or remove a reader. Modes: "link" (anyone with the URL), "people" (the listed addresses, who sign in to read it) and "private" (revokes the link; a URL already sent stops working). "link" and "people" require confirm: true; without it nothing changes and the response describes what would be disclosed. "private" needs no confirmation. For "people", emails replaces the reader list, and add and remove change individual addresses. Addresses new to the list are emailed a link.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"id": "<id>",
"mode": "<mode>"
},
"name": "tp_share_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Document id from tp_list_documents. | |
| add | No | Addresses to add to the current reader list for mode "people". They are emailed a link. | |
| mode | Yes | Who can open it: private, link or people. Required. | |
| emails | No | The complete reader list for mode "people"; it replaces the current list. | |
| remove | No | Addresses to remove from the current reader list for mode "people". | |
| confirm | No | Required when `mode` is "link" or "people". Set true after the user has agreed to that audience. |