@squirrelnotes.app/mcp-embeddings 0.0.0 → 2.1.1-test.342

package/LICENSE-MODEL.txt

@@ -0,0 +1,208 @@
+The embedding model bundled in this package (model/model.onnx, model/vocab.txt,
+model/config.json, model/tokenizer_config.json) is all-MiniLM-L6-v2 by
+sentence-transformers, https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2,
+at commit 1110a243fdf4706b3f48f1d95db1a4f5529b4d41, unmodified. Its model card
+declares the Apache License 2.0, reproduced below. The rest of this package is MIT.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,184 @@
-# @squirrelnotes.app/mcp-embeddings
+# Squirrel Notes MCP: local embeddings (opt-in)
 
-This version (0.0.0) is a placeholder, published only so that npm trusted publishing can be configured for the package. It contains no code. Do not install it.
+`@squirrelnotes.app/mcp-embeddings` is the Squirrel Notes stdio MCP server
+with **semantic memory search**. `search_memory` finds a memory by its meaning
+as well as its words, so *"what coffee do they order?"* can find *"Orders a
+flat white with oat milk"*.
 
-The real package — opt-in local embeddings for the Squirrel Notes MCP server (`@squirrelnotes.app/mcp`) — is published from the project's CI with npm trusted publishing.
+It is the same server as [`@squirrelnotes.app/mcp`](https://www.npmjs.com/package/@squirrelnotes.app/mcp):
+the same tools, the same inputs and the same output shape. It is built from the
+same source and published from the same commit, at the same version. The
+only differences are the order `search_memory` returns, its `ranking` (`hybrid`) and each hit's
+`semanticScore`, which the base package sends as `null`. If you do not install it,
+nothing changes for you.
+
+## What stays on your machine
+
+- **The model runs locally.** It is all-MiniLM-L6-v2, a small English
+  sentence-embedding model. It runs in this process, on your CPU, through
+  ONNX Runtime. **No memory text is sent anywhere to be embedded**: not to
+  Squirrel Notes, not to HuggingFace, and not to any embedding API.
+- **The model ships inside the package.** Nothing is downloaded when the
+  server runs, so embeddings work offline.
+- **ONNX Runtime's own telemetry is turned off.** The runtime's official
+  macOS and Linux builds report usage to Microsoft by default. This package
+  sets `ORT_DISABLE_TELEMETRY=1` before the runtime loads, whatever your
+  environment says. **On Windows** the runtime reports through Windows' own
+  event tracing (ETW) instead, which that setting does not affect; whether
+  those events leave your machine depends on your Windows diagnostic-data
+  settings.
+- **Vectors stay local and encrypted.** Embedding vectors can reveal roughly
+  what a text said, so they are treated like the text itself:
+  - they are never sent to the server, never logged and never returned by a
+    tool;
+  - they are kept in one file per account in your OS cache directory
+    (`~/Library/Caches/squirrel-notes/` on macOS, `$XDG_CACHE_HOME` or
+    `~/.cache` on Linux, `%LOCALAPPDATA%` on Windows);
+  - that file is encrypted with AES-256-GCM, under a key derived (HKDF-SHA256)
+    from your data key, and written with mode `0600`. Windows ignores Unix
+    modes; there the file has your user profile's permissions.
+- **What still leaves your machine is what always did.** The server stores your
+  memories as ciphertext only. `search_memory`'s *results* (the memory text)
+  go to the agent that asked, and so to that agent's model provider, exactly
+  as with the base package.
+
+**What the encryption does not protect against:** anyone who can read your MCP
+client config. That file holds your passphrase, which unlocks the data key,
+which unlocks the vector file. The encryption protects the vector file when it
+leaks on its own: in a backup, a synced folder or a support bundle.
+
+## Install (opt-in)
+
+Change `args` in your MCP client config from the base package to this one. The
+`env` block stays the same; add `ONNXRUNTIME_NODE_INSTALL` as shown.
+
+```json
+{
+  "mcpServers": {
+    "squirrel-notes": {
+      "command": "npx",
+      "args": ["-y", "@squirrelnotes.app/mcp-embeddings"],
+      "env": {
+        "SQUIRREL_API_BASE_URL": "https://api.squirrelnotes.app",
+        "SQUIRREL_API_KEY": "sqn_<your_api_key>",
+        "SQUIRREL_PASSPHRASE": "<your_passphrase>",
+        "ONNXRUNTIME_NODE_INSTALL": "skip"
+      }
+    }
+  }
+}
+```
+
+**Why `ONNXRUNTIME_NODE_INSTALL=skip`.** The runtime, `onnxruntime-node`, has an
+install script. On Linux x64 only, that script downloads the NVIDIA CUDA
+add-ons from nuget.org by default, checking no hash. This
+package does not use the GPU, so the download is never needed. The setting turns
+it off. On macOS, Windows and Linux arm64, the script downloads nothing.
+
+**Pinned dependencies.** The package ships an `npm-shrinkwrap.json`, so npm
+installs exactly the dependency versions that were audited and licence-checked
+for the release.
+
+**Size.** The package is about 17 MB to download, most of it the model.
+`onnxruntime-node` adds about 300 MB unpacked, because it ships binaries for
+every platform. That is why embeddings are a separate package.
+
+To go back to lexical search, change `args` back to `@squirrelnotes.app/mcp`.
+The vector file can be deleted at any time; it is rebuilt when needed.
+
+## How search ranks
+
+- Without this package, `search_memory` is lexical: BM25 over the words of each
+  memory's text, entity and tags, times a recency decay per category.
+- With it, two orders are fused by reciprocal rank fusion (k = 60): the
+  lexical order, and the semantic order (cosine similarity between the query
+  and each memory, times the same recency decay). Each order counts the decay
+  once, and the fused score is not multiplied again. A memory in both orders
+  ranks above one in only one.
+- A semantic match must reach a minimum similarity of 0.35. Below that, a
+  memory is returned only if its words match.
+- `score` is on a 0–1 scale here, and unbounded BM25 in the base package. It
+  orders one response only: a memory found by one order alone scores about 0.5
+  whatever its relevance. The keys are the same in both.
+- To judge a hit, use the absolute scores: `semanticScore` (the cosine
+  similarity, reported for every hit, also those below 0.35 found by words) and
+  `lexicalScore` (the share of the query's content words, stopwords aside).
+  As a guide, from the recall gate's data (ADR-0444): below `semanticScore`
+  0.45 and `lexicalScore` 0.67 a hit is rarely the answer (about 1 in 20); at
+  `semanticScore` ≥ 0.45 about half are, and at `lexicalScore` ≥ 0.67 about
+  9 in 10. These were measured on the delivered (rounded) scores. `semanticScore` is a cosine, −1 to 1
+  (in practice about −0.1 to 0.9). `ranking` is `hybrid` when the semantic
+  order ran, `lexical` while the model loads or after it fails.
+- Words outside ASCII letters and digits never match lexically, in either
+  package. Embeddings can find some of these memories (see *Recall*).
+- A query with no ASCII letters or digits always comes back with a `note`.
+  It says the query cannot be searched, unless the semantic ranking actually
+  ran, in which case it says the results were found only by meaning.
+
+## When it is lexical anyway
+
+Search falls back to the base package's lexical order, and says so once on
+stderr, never per call, when:
+
+- `SQUIRREL_MEMORY_EMBEDDINGS=0` is set;
+- a model file's size or SHA-256 differs from `model-manifest.json`, or a
+  model file is missing (the model is refused, never loaded);
+- ONNX Runtime cannot load on your platform;
+- the runtime fails during a search (lexical for the rest of the session).
+
+While the model is still loading at start-up (a fraction of a second), search
+is lexical too.
+
+**First searches.** Each memory is embedded once, then only again when it
+changes (its revision moves). A search spends at most 8 seconds embedding
+memories that have no vector yet; the rest still rank lexically until a later
+search embeds them. Measured on an Apple M1 Pro: 500 memories in 4.4 s, 5,000
+in 26.7 s.
+
+## Model integrity
+
+`model-manifest.json` pins the model to a commit of
+[`sentence-transformers/all-MiniLM-L6-v2`](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2)
+(`1110a243…`, the quantised `onnx/model_qint8_arm64.onnx`, which runs on any
+CPU). It records each file's size and SHA-256.
+
+- The release workflow fetches the files from that commit, never from a
+  branch. It refuses any file that does not match, and checks them again
+  before packing.
+- Every start reads each file, checks it, and gives the runtime the same bytes
+  it checked, so a file replaced after the check is never loaded.
+- `SQUIRREL_MEMORY_MODEL_DIR` can point at a copy you placed yourself. It goes
+  through the same check.
+
+The model is Apache-2.0; see `LICENSE-MODEL.txt`. This package is MIT.
+
+## Recall
+
+The release is gated on a recall test (`npm run test:recall`). It compares
+recall@5 of lexical and hybrid search on 500 memories and 160 queries.
+
+- The corpus is **synthetic and written by an AI agent**, not user data, which
+  zero-knowledge encryption makes unreadable.
+- Hybrid search must gain at least 15 points on paraphrased queries, and must
+  not lose on exact-word queries.
+- The latest results are in ADR-0444 in the Squirrel Notes repository.
+
+## Environment variables
+
+Everything in the base package's README applies, plus:
+
+| Variable | Default | Description |
+|---|---|---|
+| `SQUIRREL_MEMORY_EMBEDDINGS` | on | `0` turns semantic search off (lexical only). |
+| `SQUIRREL_MEMORY_MODEL_DIR` | the package's `model/` | Directory holding the model files. They are checked against the manifest. |
+| `SQUIRREL_MEMORY_CACHE_DIR` | the OS cache directory | Where `squirrel-notes/memory-vectors-<id>.bin` is kept. |
+| `ONNXRUNTIME_NODE_INSTALL` | — | Set to `skip` so the runtime's install script fetches no GPU add-ons (Linux x64). |
+
+## What is logged
+
+Everything in the base package's list, plus one line at start-up: either
+*local embeddings ready*, or *were not loaded*, followed by a reason (`manifest`,
+`missing`, `integrity` or `runtime`) and, for the first three, a file name.
+After that, a line appears only if the runtime fails or the vector file cannot
+be written, and then only once. No line contains memory text, a query or a
+vector.