Read one document in full
get_documentFetch the full text of one guide, article or set of questions by its slug, as Markdown, not HTML. Slugs come from search_documents or list_documents.
The answer carries the MCS documents the text draws on, and the ids of any calculators on this site that do the arithmetic the text describes. Where the document is a set of questions, each question and answer comes back separately.
Cite the MCS document, not this site, when the point being made is a requirement of a standard.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | Yes | The document's slug, from search_documents or list_documents. Required. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The page, which is the address to cite. | |
| kind | Yes | 'guide', 'article' or 'faq'. | |
| slug | Yes | ||
| tags | No | ||
| text | No | The document as Markdown: prose, with headings, tables, lists and absolute links. For a set of questions this is every question and answer run together; they also come back separately in questions. | |
| level | No | Articles only: beginner, intermediate or advanced. | |
| title | Yes | ||
| apiUrl | Yes | The same document as JSON. | |
| related | No | Documents worth reading next. | |
| sources | No | The MCS documents this draws on. Cite these, not this site, when the point is a requirement of a standard. | |
| summary | Yes | ||
| updated | Yes | The date of the last change, as YYYY-MM-DD. | |
| category | Yes | The subject key: 'basics', 'heat-pumps', 'solar-pv', 'batteries', 'standards' or 'paperwork'. | |
| featured | No | ||
| headings | No | The in-page sections. | |
| questions | No | For a set of questions, each question with its answer as Markdown. | |
| levelLabel | No | ||
| calculators | No | Ids of calculators on this site that do the arithmetic described here. | |
| perspective | No | Guides only: who the guide is written for. | |
| categoryLabel | Yes | ||
| readingMinutes | Yes | ||
| perspectiveLabel | No |