Skip to content
Back to search

Annex-Library

MCP server for managing a local git-annex library

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/flmaximwang--annex-library/badge.svg)](/listings/flmaximwang--annex-library)

HTML

<a href="/listings/flmaximwang--annex-library"><img src="/api/listings/flmaximwang--annex-library/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requires Python 3.11 or later, Git, git-annex, and an existing library checkout that follows the [catalog layout](docs/CATALOG.md).

git clone https://github.com/flmaximwang/Annex-Library.git
cd Annex-Library
python3 -m venv .venv
.venv/bin/python -m pip install .

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 54 lines
  1. # Annex Library
  2. Annex Library is a Model Context Protocol (MCP) server for managing a local git-annex library. The server searches the catalog, locates attachments, validates archive records, saves prepared DOI and Misc entries, and edits catalog metadata.
  3. The server builds a SQLite index from catalog Markdown and tracked files. It stores the index outside the library checkout and can rebuild it from the checkout.
  4. ## Installation
  5. Requires Python 3.11 or later, Git, git-annex, and an existing library checkout that follows the [catalog layout](docs/CATALOG.md).
  6. ```sh
  7. git clone https://github.com/flmaximwang/Annex-Library.git
  8. cd Annex-Library
  9. python3 -m venv .venv
  10. .venv/bin/python -m pip install .
  11. ```
  12. ## MCP setup
  13. Add the following entry to the MCP client's configuration. Replace both paths with absolute paths on your machine.
  14. ```json
  15. {
  16. "mcpServers": {
  17. "annex-library": {
  18. "command": "/path/to/Annex-Library/.venv/bin/annex-library-mcp",
  19. "args": ["--library", "/path/to/Library"]
  20. }
  21. }
  22. }
  23. ```
  24. The server uses stdio. Pass `--index /path/to/index.sqlite3` to use a separate cache for the checkout. To build the index and inspect its status, run `.venv/bin/annex-library-mcp --library /path/to/Library --status`.
  25. ## Tools
  26. | Tool | Function |
  27. | --- | --- |
  28. | `annex-lib-search` | Search by DOI, title, author, tags, capture dates, collection, or free text. Results group linked versions by work and identify the version that matched. |
  29. | `annex-lib-attachments` | List tracked attachments by `path` or `entry_id`, including git-annex placeholders. Set `refresh_local` to `true` to check current local availability. |
  30. | `annex-lib-check` | Report archive structure and metadata issues for a Library-relative `path` or the full checkout. |
  31. | `annex-lib-save` | Archive `metadata` (including the Markdown `body`) and optional absolute `staged_files` with a stable `request_id`. |
  32. | `annex-lib-edit` | Apply `field_updates` to the YAML of the record at `path` with the expected `revision` and a stable `request_id`. |
  33. Save and edit return the record locator and local commit SHA on a committed change. Retry `committed_index_pending` with the same request ID and payload to recover search visibility.
  34. For example, call `annex-lib-search` with `{"title": "conductive protein heme", "include_local_status": true}` to find matching works and include current attachment availability.
  35. ## Tests
  36. ```sh
  37. .venv/bin/python -m pip install '.[dev]'
  38. .venv/bin/python -m pytest
  39. ```

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.