@shieldfive/mcp 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,200 @@
+# Changelog
+
+All notable changes to `@shieldfive/mcp` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 0.2.0 - 2026-09-16
+
+The first version published to npm. 0.1.0 below was tagged in this changelog
+and never published; nothing depends on its behaviour, but its contract did
+change here — a confirmed call now needs the `plan_token` its preview returned —
+so the version moves a minor step rather than a patch, as semver asks of a 0.x
+release that breaks callers.
+
+Fixes from a second review before the first publish. Each item has a test that
+failed before its fix.
+
+### Security
+
+- A confirmed call was not bound to the preview the user approved. `confirm:
+  true` planned the operation again from scratch, so a directory that had grown,
+  a destination that had appeared, or a path that now pointed at a different file
+  was acted on without the user ever being shown it. Each preview now returns a
+  `plan_token`; a confirmed call must carry it, and the tool refuses
+  (`plan_changed`) when the plan it builds differs from the one approved, naming
+  what changed. Tokens are single use and expire after ten minutes.
+- The trash directory was never resolved or `lstat`'d. With
+  `<root>/.shieldfive-mcp-trash` a symlink out of the root, `trash_local` and an
+  overwriting `move_local` moved the user's files and the manifest out of the
+  root. The directory is now checked while planning, created without following
+  links and checked again before anything moves in; a link or a non-directory
+  there is refused (`trash_unsafe`).
+- A dangling symlink read as a free path. A move onto one previewed
+  `replaces_existing: false`; on the same device the link was replaced with no
+  trash entry, and across devices the copy wrote through it, outside the root,
+  before removing the source. At a destination it is now an existing entry, and
+  anywhere a write would pass through it the write is refused
+  (`dangling_symlink`).
+- The cross-device move fallback deleted data. It `rm -rf`'d whatever was at
+  `<destination>.shieldfive-mcp-incoming`, dropped FIFOs, sockets and device
+  files and then removed the source tree, and removed a file's source without
+  flushing or checking the copy. A cross-device move now copies under a fresh,
+  exclusively created name, refuses symlinks and special files in the tree
+  (`symlink_in_tree`, `special_file_in_tree`), flushes and verifies every file by
+  size and SHA-256 against a source that has not changed
+  (`copy_verification_failed`, `source_changed`), and removes the source entry by
+  entry, only what is unchanged since it was copied (`source_left_in_place`).
+- The trash lived per root rather than per volume, so for a root such as
+  `/Volumes`, trashing from an external drive copied the tree onto the boot
+  volume. An item's trash is now on its own volume, in the highest directory
+  between it and its root on that device; a move into the trash is always a
+  rename; a mount point cannot be trashed (`trash_no_same_volume`).
+- `trash_local` on a symlink trashed the tree it pointed to, and `rename_local`
+  renamed the file behind a link. `move_local`, `rename_local` and `trash_local`
+  now act on a link itself, never on its target.
+- `rename_local`'s "never replaces" was a check followed by `rename(2)`. Renames
+  and moves now use operations that fail when the destination exists: a hard link
+  then an unlink for files, a recreated symlink, a rename over an empty
+  placeholder for directories. Special files, filesystems without hard links and
+  directories on Windows still fall back to checking and then renaming;
+  SECURITY.md records the window that leaves.
+
+### Fixed
+
+- `find_duplicates` spent its hashing budget all-or-nothing per size group, so
+  the most valuable group was skipped when its worst case did not fit and the
+  smaller groups behind it were hashed instead. The budget is now spent per file,
+  largest group first, hashing a group in part when it must
+  (`groups_partially_hashed`, `files_not_hashed`).
+- The copy nominated to keep was chosen by modification time, with ties left to
+  directory order. A tie now goes to the shorter path, then to the path in
+  code-unit order (`compareKeeper`).
+- Hardlinks counted as reclaimable space. Names of one file are now one copy,
+  listed under `hardlinked_names`, and `reclaimable_bytes` counts files on disk.
+- A trash batch that failed after moving something could report the moved item
+  as recorded "in no manifest (nothing moved)", and the structured detail never
+  reached the client. The error now names each moved item and its manifest, and
+  the detail is returned as a second content block.
+- Manifest updates raced: concurrent calls in the same millisecond shared a batch
+  and lost entries, and a corrupt manifest was silently reset. Each call now has
+  its own exclusively created batch directory; its manifest is written before
+  anything moves, atomically and one write at a time, and no manifest this
+  server did not write is read or replaced.
+- Path arguments and `new_name` were trimmed, so `"report "` acted on
+  `"report"`. They are used exactly as given.
+- `limit`, `max_files`, `max_files_hashed`, `paths` and `new_name` had no upper
+  bound, and a refusal echoed its input whole. They are capped — 10,000 rows;
+  1,000,000 files; 1,000,000 hash reads; 1,000 paths; 255 bytes — at the MCP
+  schema and again in the handlers, and echoed values are cut short.
+- `trash_local` counted a path given twice twice, and given a folder and
+  something inside it, moved the folder and then failed on the file. A repeated
+  path is taken once and an overlap is refused before anything moves
+  (`overlapping_paths`).
+- The mutating tools ignored cancellation. Nothing starts once a request is
+  cancelled (`cancelled`); a trash batch stops between items
+  (`cancelled_partially_applied`); a move is rolled back until its source starts
+  being removed. The SDK sends no response to a cancelled request, so the server
+  logs what happened.
+- `scanned` listed roots the file budget never reached. Payloads carry
+  `scanned` and `not_scanned`, and the warning names the roots never reached.
+
+### Changed
+
+- A symlink given as the destination of `move_local` is an entry that
+  `overwrite` can replace, not a directory to move into. Give the real path of a
+  directory to move into it.
+- The server version is read from `package.json` rather than kept as a second
+  copy.
+- The README said scans stop at "64 directory levels"; they walk the root and
+  64 levels of subdirectories below it.
+- Removed a scratch script committed at the repository root, a `.npmrc` and
+  `.gitignore` entries left over from other projects, and renamed a test whose
+  name contradicted its assertion.
+
+### Not covered
+
+- The cross-device tests need a RAM disk and run only on macOS; elsewhere they
+  are skipped, visibly. Windows remains untested.
+
+## 0.1.0 - 2026-09-14
+
+Initial release.
+
+### Added
+
+- Nine local file-management tools over MCP stdio: `list_local`,
+  `find_duplicates`, `find_large_files`, `find_old_files`, `storage_summary`,
+  `move_local`, `rename_local`, `create_local_folder`, `trash_local`.
+- Root-based containment. Every path is `realpath`-resolved, following symlinks,
+  and must land inside a directory the user named at startup. No default root,
+  no override.
+- Content-based duplicate detection: grouped by size, then by a hash of the
+  first 64 KiB, then confirmed by a full SHA-256. Filenames are never used to
+  decide identity.
+- `confirm: true` gating on every tool that changes the filesystem. Without it,
+  each returns the plan its real code path produced and changes nothing.
+- `trash_local` moves rather than deletes, into a `.shieldfive-mcp-trash`
+  directory inside the item's own root, with a `manifest.json` recording the
+  original location.
+
+### Security
+
+- Path containment was attacked across four independent lenses before release.
+  Two data-loss paths in `move_local` were found and closed: an overwriting move
+  called `rm(destination, {recursive: true, force: true})`, which destroyed every
+  file under an overwritten directory while the README claimed the server deletes
+  nothing; and a directory moved onto its own parent resolved its final path to
+  the source itself, so the same branch deleted the source outright. Overwriting
+  now moves the displaced item to the trash, and the self-move case is refused.
+- `walkRoots` threw `RangeError` on any root over roughly 125,000 files — below
+  the 200,000-file cap the schema advertises — because it spread the per-root
+  array into `push()`. It appends in a loop, and `max_files` is now a budget
+  across all roots rather than per root.
+- The hidden-entry check ran on the dirent before `lstat`, so a dot-named symlink
+  was counted as hidden and never reached the symlink branch.
+- Files with a link count above one are counted and reported in scan warnings.
+  `realpath` resolves symlinks but not hardlinks, so containment cannot see a
+  second name for the same inode outside the roots.
+- Request cancellation is plumbed through to the walk and to hashing. A cancelled
+  scan previously ran to completion.
+- A cross-device directory move is transactional. It stages the copy beside the
+  target and renames it into place only once the whole tree has landed, so a
+  failure mid-walk leaves the source untouched and nothing at the destination.
+  Previously an interleaved copy+remove tore the source in half while the
+  already-removed destination was gone for good. A move that would both displace
+  an existing destination and carry a symlink in its tree is now refused before
+  anything is displaced, and if the replacement fails after a displacement the
+  displaced item is put back.
+- Path arguments are capped at 4096 characters. An oversized path was reflected
+  verbatim into the error message and into the model's context.
+
+### Notes
+
+- **This version cannot see a ShieldFive vault.** The vault API accepts only a
+  full account JWT, which also opens the wrapped-root-key route and every
+  content download, and cannot be scoped down. Holding one would make the
+  content boundary a matter of restraint instead of capability. Vault tools wait
+  for a scoped, metadata-only key. The reasoning is set out in
+  `docs/mcp-v1-step0-discovery.md` in `shieldfive/web`.
+- No network module is imported, `fetch` is never called, no subprocess is
+  spawned, and `SHIELDFIVE_MCP_ROOTS` is the only environment variable read.
+  Each of those is asserted by a test rather than only claimed here. The
+  assertion covers this package's source, not its dependency tree, and
+  SECURITY.md says so.
+- Reporting was corrected in several places where a result was quietly
+  incomplete: `storage_summary` omitted hidden files and build directories from
+  its totals with no warning at all; `find_old_files` was the one tool that kept
+  its warnings out of the summary line; the duplicate-hashing budget counted only
+  the 64 KiB head pass, leaving the whole-file pass unbounded, and abandoned
+  entire same-size groups when they did not fit — biased against the groups worth
+  the most, since a group is large precisely because it has many copies.
+- `formatBytes` promoted units before rounding, so 999,999 bytes rendered as
+  "1000 KB".
+- `storage_summary` credited each file only to its immediate parent, so a large
+  tree split across subfolders never appeared in `largest_directories`.
+- Windows is untested. The code uses no POSIX-only API and paths go through
+  `node:path`, but nobody has run it there.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 2026 Cho Garcia
+
+   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.