Documents
Documents
Documents is where your team writes and keeps pages of prose: notes, runbooks, briefs and drafts, with every change kept as a version, comments pinned to passages, attached files and an optional public link.
In the sidebar under Content → Documents. Needs: Projects and Folders. A document can belong to a project and be filed in a folder.
Documents screen
The screen has two parts.
- The list, on the left: every document you may see, with its title, project, when it was last changed, "shared" when it has a public link, its author, when it was created and its tags. Switch between All and Shared with me, which shows documents someone else shared with you, and says how each reaches you: shared with you, through a team you are in, with everyone, or through the folder it is filed in. Search by title, tag or note. New creates an untitled document and opens it.
- The document, on the right: its title, its Project, Tags and a short Note, then the text itself. Below the text are three panels: History, Comments and Attachments. A status line says whether your changes are saved, and how many words and minutes of reading the document holds. A View only badge shows when you may read but not change it.
You see a document when you wrote it, when it was shared with you or a team you are in, when it belongs to a project you are a member of, or when it sits in a folder shared with you, or under one. An administrator sees every document. A document filed under a project is also listed on that project's home page.
Write a document
- Choose New. An untitled document opens.
- Type a title, and pick a Project if it belongs to one.
- Write. Type
/for headings, bulleted and numbered lists, a quote, a code block, a table or a divider. - Your work saves itself two seconds after you stop typing. Save, or Ctrl+S / Cmd+S, saves at once.
- Add Tags (comma separated) and a Note. The list's search looks in both, as well as the title.
Focus hides everything but the document and offers Text size, Line spacing and Line width. These are remembered in this browser only. Read stops editing while you read it through; Edit goes back.
See and restore an earlier version
- Choose History. Every save that changed the text is listed, newest first.
- Choose Compare to see what changed between that version and now.
- Choose Restore to put it back. The current text is kept as a version first, so a restore can be undone the same way.
Comment
- Select a passage and choose Comment on selection, or just type in Add a comment… to comment on the whole document.
- Choose Comment. Resolved comments are shown dimmed.
Commenting needs only permission to read documents.
Attach a file
- In Attachments, choose Attach file and pick the file.
- Give it a caption, tags and a note so others know what it is.
- Download fetches it. Remove file takes it off the document for good.
Agents can read an attached file with the Files reader, below.
Share with people, a team or everyone
Share opens who has the document now, and lets you give it to a person, a team or everyone here, to read or to edit. It shows to the document's author and to administrators, when they may also manage folders.
Share a document by link
- Choose Share link, then Copy link. The link has the form
https://<your-deployment>/share/documents/…. - Anyone with the link can read the document and comment on it without signing in.
- Choose Stop sharing to make the link stop working. Making a new link makes the old one stop opening.
Filing a document in a folder that is shared also shares the document with everyone the folder is shared with. See Sharing and visibility and Folders.
Turn a passage into a task
Select some text and choose Task from selection. A task is created on the Tasks screen with the selection as its title. This needs permission to change tasks.
Delete a document
Choose Delete and confirm. The document goes with every version, comment and attachment.
Files reader
The Files reader has no screen of its own. It is what lets an agent read a file, such as a document's attachment, a mail attachment or a file in Media, without you pasting its text into the chat. It reads PDFs, Word files, spreadsheets and plain text.
- It can give a file's outline (its pages, headings or sheets), read one slice of text at a time, find words in a file, and read a spreadsheet's cells.
- It can bring a file in from a public web link, or hand out a one-time upload link so a large file does not pass through the conversation.
- It can fill an Excel template and keep the result as a new file.
| Permission | Label | Lets you |
|---|---|---|
files:read | Read files | Let an agent read the files you may already see. |
files:write | Bring files in | Let an agent download a file from a link, make an upload link, or keep a filled template. |
Nothing in the Files reader runs on a schedule. It needs nothing else switched on.
Read only: files.inspect, files.search
Read: files.read, files.readCells
Bring files in: files.fetch, files.requestUpload, files.fillTemplate
Who can do what
| Permission | Label | Lets you |
|---|---|---|
docs:read | View documents | Open Documents, read the documents you may see, look at their history, download attachments, comment and resolve comments. |
docs:write | Manage documents | Create, edit, file, restore and delete documents, attach and remove files, remove comments, and turn a public link on or off. |
Which documents you see is decided per document, as described above. See People, roles and permissions.
What happens on its own
Nothing in this module runs on a schedule.
What agents can do
An agent can find and read documents, write and change them, file them in folders, comment, read the history and put an earlier version back, describe or remove attachments, and take away a public link. It cannot delete a document and cannot turn a public link on: who may read somebody's writing is theirs to decide. By default reads go through, and anything that changes or removes something waits for a person to approve, unless an approval rule says otherwise. See Agents and approvals.
Read only: docs.list, docs.read, docs.comments, docs.versions, docs.version
Write: docs.create, docs.update, docs.comment, docs.resolveComment, docs.updateAttachment, docs.restoreVersion, docs.unshare
Reaches others: docs.move files a document in a folder, or takes it out. Because everyone a folder is shared with can read what is in it, a move can be a share.
Remove (cannot be undone): docs.removeComment, docs.removeAttachment
docs.createanddocs.updatetake the body as HTML, which is cleaned on the way in. Every change keeps a version.docs.removeCommentdeletes a comment and its replies: your own, any on a document you wrote, or any if you are an administrator.docs.unsharetakes a document's public link away.
Over MCP the same tools are named docs__list, docs__read and so on. See API keys and MCP access.