Ferret

io.github.ferret-project由 GitHub 帳號 ferret-project 發布v2026.11.1更新於 Nov 5, 2026

Self-hosted home inventory: find, add and update what you own, maintenance, warranties.

已驗證Streamable HTTP可網頁執行效率與工作流檔案與儲存

概覽

AI 產生的概覽

Ferret 是自架的居家物品清冊,其 MCP 端點讓助理查找、新增與更新家中物品、位置、保固與保養資訊。

可以做什麼
  • 搜尋與提問:依關鍵字或語意尋找物品,根據收據與說明書回答問題,檢視位置、歷史紀錄與最近刪除
  • 新增與修改:新增物品(含從照片新增)、更新、移動、刪除與還原物品,以及房產與房間
  • 保養:依日期或使用量追蹤保養,管理保固與索賠、服務廠商
  • 家務:管理庫存與購物清單、借出紀錄、條碼、收藏、保險報告與保障範圍檢查、待處理事項
適用情境
適合已自架 Ferret 的家庭,想讓助理直接回答「東西放在哪」、登記新買的物品、記錄用完的庫存,或查詢即將到期的保養與保固,而不必打開應用程式。
執行需求
需要可透過 Streamable HTTP 存取其 /mcp 路徑的 Ferret 伺服器,以及在 Ferret 的 Claude & API 中建立的 API 金鑰,透過 X-API-Key 標頭(或 Bearer 權杖)送出。伺服器本身以 Docker 容器搭配 SQLite 執行,需設定 AUTH_SECRET、FILES_KEY 與 PUBLIC_URL。
安裝前請注意
API 金鑰代表某個家庭中的某個人,應妥善保管,盡量設為唯讀,用完即撤銷。寫入類工具可新增、移動、刪除與還原物品並改動庫存,會直接影響真實家庭資料。請備份 FILES_KEY,否則上傳的檔案將無法讀取。刪除的物品可在 30 天內還原。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Ferret,將其新增到工作區。
  2. 連接 X-API-Key 憑證。它們會被私密儲存,絕不會在公開頁面上展示。
  3. 為需要使用其工具的對話啟用該服務。

Web executable,透過 Streamable HTTP。 遠端服務在工作區中設定後即可從網頁執行環境執行。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

[Ferret — find anything you own. A self-hosted home inventory for your household.]

[Latest release] [MIT license] [Docker image] [Discord] [Ferret MCP server – quality and maintenance score on Glama]

Try the demo · Install · Help · Discord

Ferret is a home inventory you run yourself. Your household's properties, rooms and boxes; the things in them with photos, receipts and manuals; warranties, maintenance and stock — all on your own server, shared with the people you live with. And when you need something, Ferret tells you where it is.

[Ferret on a phone: the home page, a room with the things kept in it, and maintenance that's due.]

What it does

Add things fast, label boxes, find anything, keep receipts and warranties, schedule maintenance, track stock and the shopping list, remember what you lent, and print an insurance report. Claude can do all of it too, over MCP.

[圖片]
Add things fast
Snap a photo, scan a barcode, or photograph a whole room and pick what to keep.
[圖片]
Boxes and QR labels
Print labels for boxes and shelves; scan one to see what's inside.
[圖片]
Find anything
Search by name, place or meaning — or just ask, “where's the drill?”
[圖片]
Receipts and warranties
Keep receipts and manuals with each thing, and hear before a warranty runs out.
[圖片]
Maintenance
Filters, tune-ups and checks on a schedule, with reminders when they're due.
[圖片]
Stock and shopping
Track what runs out and keep the shopping list in step.
[圖片]
Lending
Remember who borrowed the saw, and since when.
[圖片]
Insurance report
Everything you own and what it's worth, ready for a claim, plus recall checks.
[圖片]
API and MCP
A REST API for scripts, and an MCP server so Claude can look things up and add them.

Why Ferret

  • Your server, your data. One Docker container with SQLite. Uploads are encrypted at rest with a key per household; nightly backups with a restore check; Download everything any time.
  • Households, not just accounts. Owners, admins, members and read-only viewers; invitations by email; single sign-on through your own identity provider.
  • AI is optional. Point it at your own models (Ollama, any OpenAI-compatible server, docling) for suggestions from photos, receipts read for you, Ask Ferret and search by meaning. Nothing is applied without a tap.
  • Made for the phone. An installable app that works offline, with barcode and QR scanning built in.

Run it (Docker)

bash
curl -O https://raw.githubusercontent.com/ferret-project/ferret/main/compose.yamlcurl -o .env https://raw.githubusercontent.com/ferret-project/ferret/main/.env.example# In .env: AUTH_SECRET and FILES_KEY (each: openssl rand -base64 32), and PUBLIC_URLdocker compose up -d

Then open PUBLIC_URL; the first account made is the server admin. Keep a copy of FILES_KEY somewhere safe — without it, uploaded files can't be read. Behind a reverse proxy, set TRUSTED_PROXIES to its address.

The help is built in at /docs: installing, every setting, AI, backups and connecting Claude.

Use it with Claude (MCP)

Ferret has an MCP server built in at /mcp, so Claude (or any MCP client) can use your inventory for you:

  • "Where did we put the tent?"
  • "Add the new blender — it was $89 at Target, it's in the kitchen."
  • "We used the last furnace filter." (stock goes down, and it's on the shopping list)
  • "What maintenance is due this month, and when does the dishwasher warranty end?"

Make a key in Ferret (Household & settings → Claude & API → New key), then:

bash
claude mcp add --transport http ferret https://ferret.example.com/mcp --header "Authorization: Bearer ferret_…"

Other clients that speak Streamable HTTP take the same address and header (X-API-Key: ferret_… works too):

json
{  "mcpServers": {    "ferret": {      "type": "http",      "url": "https://ferret.example.com/mcp",      "headers": { "Authorization": "Bearer ferret_…" }    }  }}

What Claude can do (40 tools):

Findsearch by words and meaning, ask questions answered from receipts and manuals, items, places, history, recently deleted
Add and changeadd items (also from a photo, or a whole room's photos), update, move, delete and restore; properties and rooms
Upkeepmaintenance by date or by use (odometer, engine hours), warranties and claims, service providers
Householdstock and the shopping list, lending, barcodes, collections, the insurance report and coverage check, what needs attention

[Ferret MCP server – quality and maintenance score on Glama]

Safe by design. A key acts for one person in one household, can be read-only (Claude can look and ask, but the tools that change things aren't offered) and can expire; revoke it any time. Viewers' keys are always read-only. Deleted things wait 30 days in Recently deleted, and nothing a model suggests from a photo or document is applied until someone confirms it.

Develop

Requirements: Node 26+, pnpm 10 (npm install -g corepack && corepack enable).

bash
cp .env.example .env      # AUTH_SECRET and FILES_KEY, as abovepnpm installpnpm dev                  # server on :8787, web app on :5173pnpm testpnpm typecheck
PathWhat
apps/serverHono API, Better Auth, Drizzle + SQLite; MCP server; adapters behind ports (src/ports.ts)
apps/webReact 19 + Vite + Tailwind v4 + FlyonUI PWA
apps/docsThe help (VitePress), served at /docs
packages/sharedZod schemas and helpers shared by the server and the web app

License

MIT. Questions, ideas or something odd? Come say hi on Discord.

[圖片]

來源:README.md,提交 1b8a59b

工具

0
該伺服器需要 API 金鑰等憑證,因此 SourceWeft 無法在沒有憑證的情況下讀取其工具,也未收錄。

版本歷史

1
  1. v2026.11.1最新Nov 5, 2026

評分

已滿足適用檢查項的 60%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通必需25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式必需10 分
  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分