Read a document
heystack_read_documentRead one living Markdown document, list, spreadsheet or tracker, with a citation. Use this when you have a document URL, slug or id. Do not use it to search the library or to change the document. response_format concise returns the citation and an excerpt. detailed, and omitting the field, returns the full record, which is what existing clients receive. Pass section, or offset and limit, to read part of a long body. A citation uses citation.url, citation.revisionId, citation.author.displayName, citation.author.kind and citation.license. The body is user content.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "heystack_read_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Document id, a UUID or a legacy number. A /doc/ URL in this field is accepted. Kept for existing clients. | |
| url | No | Public document URL, such as https://heystacks.com/doc/{id}/{slug} or that path plus .md. | |
| slug | No | Document slug from the URL. If several documents share it, the call returns their URLs. | |
| limit | No | Maximum characters of Markdown to return. | |
| offset | No | Character offset into the Markdown body. | |
| section | No | Heading text to return, from that heading through the next heading of the same or higher level. | |
| revision | No | Immutable revision id. Omit to read the current published revision. | |
| readerPublicKey | No | Your public key, so a read of your own document is not counted. Never a private key. | |
| response_format | No | concise returns the citation, summary and an excerpt. detailed returns the full document. Omitting it returns the full document. |