Join document
join-documentJoins a document as a collaborator. If the current user is already an owner or collaborator on the document, they have already joined it: the tool returns their existing document user unchanged.
Use this tool when:
You need to make changes to a document, but do not have a 'document user' in the document yet.
You need to make changes to a document, but your existing 'document user' does not yet have permission to change it.
To join every document matching some conditions, find them with list-documents and filter_joined=false, which leaves out the documents you have already joined.
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": {
"document_uuid": "<document_uuid>"
},
"name": "join-document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_uuid | Yes | UUID of the document to join. If you don't already have the document's UUID, use the list-documents tool to find it. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Name of the document user | |
| No | Email of the document user | ||
| party_uuid | No | UUID of the party this user belongs to. Absent when they belong to none. Do not show to the user (as the raw UUID) unless they ask for it | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| internal_user | No | true if the user has a fynk user in this account |