apple-notes-mcp 2.10.0 → 2.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +26 -3
  2. package/build/index.js +6676 -6557
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1813,7 +1813,7 @@ disabled checkboxes, block quotes and monospaced paragraphs become
1813
1813
  `blockquote` and `pre`, and inline runs keep bold, italic, underline,
1814
1814
  strikethrough, highlight, superscript, subscript, text color and safe links.
1815
1815
  Tables are semantic `<table>` elements with a header row. Images, drawings
1816
- (Notes' fallback image, or its preview), scans (PDF with preview), audio,
1816
+ (Notes' fallback image by default, SVG with `vectorDrawings: true`; see below), scans (PDF with preview), audio,
1817
1817
  video, files and link cards (title, domain and preview thumbnail) appear in
1818
1818
  body order. Attachments with no body marker are appended in creation order.
1819
1819
  An attachment with no usable source renders a visible
@@ -1823,6 +1823,22 @@ An attachment with no usable source renders a visible
1823
1823
  A folder export is one presentation document with notes separated by
1824
1824
  `<hr class="note-separator">`. It is not a backup or restore format.
1825
1825
 
1826
+ By default every drawing keeps Notes' own fallback image, a fixed-size PNG.
1827
+ With `vectorDrawings: true`, classic PencilKit drawings (`com.apple.drawing.2`
1828
+ and `com.apple.drawing`) are rendered as SVG instead, decoded through the
1829
+ public native helper exactly as [`get-note-drawings`](#get-note-drawings)
1830
+ does. The option is off by default because decoding runs the helper and costs
1831
+ extra time per note. The SVG is embedded as a data
1832
+ URL, or written to the sidecar directory with `embedAssets: false`, and it is
1833
+ subject to the same size limits as any other asset. It stays sharp at any
1834
+ zoom. Paper drawings
1835
+ (`com.apple.paper`) have no public decoder and keep Notes' fallback image or
1836
+ preview. If the helper is not built (`apple-notes-mcp setup --public-helper`),
1837
+ a drawing does not decode, the helper stopped at its stroke limit, or the SVG
1838
+ is too large, that drawing falls back to the PNG; the export never fails for
1839
+ it. The SVG traces each stroke's points with its color and mean width, so
1840
+ pencil grain and marker blending are approximated.
1841
+
1826
1842
  **Requires:** Full Disk Access. Password-protected notes are skipped in a
1827
1843
  folder export and refused for a single note.
1828
1844
 
@@ -1835,6 +1851,7 @@ folder export and refused for a single note.
1835
1851
  | `outputPath` | string | Yes | Absolute HTML file to create. Create-only: an existing file is refused with `[output_exists]` |
1836
1852
  | `embedAssets` | boolean | No | Embed assets as data URLs (default `true`). Each asset is capped at 10 MiB and a document at 256 MiB of embedded assets; a larger one renders as unavailable with a hint to use `embedAssets: false` |
1837
1853
  | `assetsDir` | string | No | With `embedAssets: false`, the sidecar directory (default `<output stem>.assets` beside the file). Existing files are never replaced; a taken name gets `-2`, `-3`, ... |
1854
+ | `vectorDrawings` | boolean | No | Render classic drawings as SVG through the public native helper (default `false`). When `false` or omitted, every drawing keeps Notes' PNG and the helper never runs |
1838
1855
 
1839
1856
  The HTML is always written to a file, because an embedded document is too
1840
1857
  large for an MCP message. Paths follow the `save-attachment` rules and may not
@@ -1842,8 +1859,14 @@ point inside the Notes library container. Sidecar URLs are relative to the
1842
1859
  HTML file, so the file and its `.assets` directory can be moved together.
1843
1860
 
1844
1861
  **Returns:** `format`, `count`, `bytes`, `output`, either `embedded` (assets
1845
- embedded) or `assets` (`dir`, `files`), `stats`, and `skipped`. Nothing
1846
- already written is deleted if a later step fails.
1862
+ embedded) or `assets` (`dir`, `files`), `stats`, and `skipped`. When the notes
1863
+ contain classic drawings and `vectorDrawings` is `true`, `vectorDrawings` reports
1864
+ `rendered` (drawings placed as SVG), `fallback` (drawings left as PNG), and
1865
+ `fallbackReasons`, a count per code such as `helper_not_installed`,
1866
+ `undecodable`, `truncated`, `timeout`, or `too-large`. After one helper
1867
+ timeout, or when the helper is not usable, the remaining drawings in the
1868
+ export are not decoded. Nothing already written is deleted if a later step
1869
+ fails.
1847
1870
 
1848
1871
  ---
1849
1872