Get document
get_documentRetrieve a document by ID to get its full description and metadata, enabling you to read the complete content when the title is insufficient.
Instructions
Read one document with its full description text.
Use it after list_documents when the title is not enough: this adds description as
markdown, alongside {id, title, project, created_at, updated_at}.
Pitfalls. The attached files are not part of this result — list them with
list_attachments(container_type='document', container_id=<this id>). A document created
with OpenProject's block editor keeps its rich content in a field API v3 does not render,
so description can be empty for a document that clearly has text in the UI; say so
rather than reporting the document as blank. Editing documents is not supported by
this server.
Cross-references: list_documents for the id; download_attachment for the files.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | Yes | Numeric document id from list_documents (it is also the number in a /documents/<id> UI URL). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Document id — pass it to get_document for the description. | |
| title | No | Document title. | |
| project | No | Project the document belongs to. | |
| created_at | No | ISO 8601 UTC timestamp. | |
| updated_at | No | ISO 8601 UTC timestamp. | |
| description | No | Description as markdown (raw); html is dropped. |