# Regan-Milne/obsideo-mcp [Health: Active]

**Category:** 📂 File Systems  
**Repository:** https://github.com/Regan-Milne/obsideo-mcp  
**GitHub Stars:** 0  
**npm Downloads (last month):** 949  
**Views:** 3  
**Installs:** 0  
**Upvotes:** 0  
**Directory Page:** https://allmcps.com/mcp/regan-milne-obsideo-mcp

## Description
Encrypted S3-compatible object storage with continuous cryptographic possession proofs. In-conversation signup (12 GB free), put/get/ls/rm/usage, optional client-side encryption; credentials stay on your machine.

## Tools
Capabilities this server exposes over MCP:

- **trial** — Create a free Obsideo account with no email and no human in the loop: a small proof-of-work and a ~10 second wait in place of identity. Returns a real account on the production network (100 MB, about 7 days, RF=3 replication, continuous possession proofs) and saves credentials locally. You usually do NOT need to call this: the first put/get/ls/usage auto-creates a trial if no account is configured. Call it to provision explicitly. To keep data beyond the trial, claim it with an email via signup_start (same account and data, quota rises to 12 GB). Takes about 15 to 30 seconds (proof of work plus a 10 second issuance window); progress is reported while it runs.
- **signup_start** — Start Obsideo signup: emails a 6-digit verification code (12 GB free tier, no card, no expiry). If a no-email trial is configured on this machine, this CLAIMS it in place: same account, bucket, keys and data, only the quota rises. Otherwise it creates a new account for the email. Use a real inbox you or your human can read; documentation placeholders and disposable domains are refused with labeled errors. Then call signup_verify.
- **signup_verify** — Complete signup with the emailed code. When claiming a trial, nothing but the quota and the identity changes (credentials stay valid, no propagation wait). For a new account, generates the Ed25519 account signing keypair locally (only the public half is sent) and stores S3 credentials in ~/.obsideo/mcp.json; re-running that path rotates credentials and keypair with no overlap, so do not re-run to retry.
- **put** — Store a local file or inline content as an object. ENCRYPTED BY DEFAULT: the bytes are encrypted client-side with AES-256-GCM using a locally generated, user-held key before they leave the machine, so the platform stores ciphertext it cannot read. The key lives only in the local config file and Obsideo has no copy: if the user loses it the data is unrecoverable, so tell them to back it up. Pass encrypt=false only when another tool must read the stored bytes directly (S3 interop); that stores plaintext. Zero-byte objects are rejected. Objects are replicated to 3 providers and verified on a continuous cryptographic challenge cycle. The first call on a fresh machine also creates the account and can take 20 to 50 seconds; progress is reported while it runs. Encrypted objects are readable only with this machine's key: there is no cross-user sharing of encrypted objects.
- **get** — Retrieve an object. Encrypted objects (the default for anything stored through this server) are decrypted automatically with the local key; retrieval from a machine without that key will fail, which is the intended property. Small text objects return inline; pass local_path for anything else. WRITES TO DISK: passing local_path writes the bytes to that path and overwrites any existing file there, so treat it as a write operation and confirm the path with your human first.
- **ls** — List stored objects (size TAB key), optionally under a prefix.
- **rm** — Delete an object by key.
- **verify** — Independently verify that the network still holds an object, without downloading it. Challenges each provider directly and compares every answer, on this machine, against a merkle root. For objects stored through this server, that root is the one this machine recorded at upload time, if the local record still has it. Pass local_path (your copy of the stored file) to compare against a root computed from that file instead. If neither is available, it falls back to the coordinator's recorded root and says so. The coordinator chooses which providers to ask, where to reach them, and the public keys their signatures are checked against. Returns how many providers proved possession right now, how many of those answers were signed, and whether any returned bad data.
- **usage** — Show account storage usage versus quota.
- **plan** — Show the account's plan: free tier or paid blocks (200 GB per block, $5/month each), status, period end, and any upgrade offer waiting for the human's agreement. Never changes anything and never contacts Stripe.
- **upgrade** — Get a Stripe-hosted checkout link for a paid plan of N x 200 GB blocks at $5/month per block. This tool charges NOTHING and changes nothing: the human opens the link and pays on Stripe's page, and the quota rises after payment. Call it only when the human has asked for more space, and hand the link back to them; do not open or submit it yourself. If the account already has a paid plan this returns the plan instead (plan size is never changed from here; only the human's click on Obsideo's emailed agree link does that).
- **portal** — Get the Stripe Customer Portal link for a paid plan: cancel, change card, download invoices. For the human to open. Cancelling keeps everything stored and readable; the account returns to its free quota at the end of the paid period.
- **backup_keys** — Copy everything needed to recover this account's data (credentials, account signing key, encryption key, upload commitments) to a path the human names. Obsideo holds no copy of the encryption key: if the local file is lost, encrypted objects are unrecoverable no matter how many providers hold them. Call this once right after the account is created and again after any signup that rotates keys. A .tar.gz path produces one archive; a directory path produces plain copies; no path produces an archive in the home directory.

## Claude Desktop Quick Installation
Install path detected from listing signals. Uses `npx` (confidence: high):

```json
"mcpServers": {
  "obsideo-mcp": {
    "command": "npx",
    "args": ["-y","obsideo-mcp"]
  }
}
```

## Documentation

## What Regan-Milne/obsideo-mcp MCP server does

Regan-Milne/obsideo-mcp MCP server connects an MCP-capable agent to Obsideo object storage. It supports ordinary object operations—uploading files or inline content, downloading them, listing keys, and deleting objects—as well as storage usage and plan information.

Uploads are encrypted with AES-256-GCM on the machine running the MCP server unless the `encrypt: false` option is selected. The encryption key is generated locally, and downloads are decrypted locally. Obsideo does not retain a copy of that key, so encrypted data depends on preserving the local credentials and key material.

The service is intended for application files, automated backups, agent artifacts, persistent memory, and other backup objects. It is not described as a CDN, queryable database, or sub-millisecond storage system.

## How it works

The server normally communicates with an Obsideo coordinator and the storage providers named by that coordinator. Objects are replicated across three providers. The `verify` operation challenges providers with chunk-level Merkle proofs and checks their responses against a locally recorded Merkle root for objects uploaded by this server. It can therefore check possession without downloading the object again.

A proof result identifies providers that passed and reports providers that could not be challenged or failed. The coordinator supplies provider locations, challenge tokens, and the public keys used for signature checks. Objects uploaded through another system can be checked with a supplied local file; without that file, verification uses the coordinator's root and identifies that basis.

The server can create a no-email trial automatically when a storage operation is first used. The trial provides 100 MB for roughly seven days and uses proof-of-work. Email signup sends a six-digit code and provides a 12 GB free tier. If a trial is configured, completing signup claims that same account rather than creating a separate one.

## Setup and configuration

Regan-Milne/obsideo-mcp MCP server can be installed in Claude Desktop by importing the released `.mcpb` extension. Other documented setups use Node's `npx` command:

```json
{
  "mcpServers": {
    "obsideo": {
      "command": "npx",
      "args": ["-y", "obsideo-mcp"]
    }
  }
}
```

Claude Code uses `claude mcp add obsideo -- npx -y obsideo-mcp`; Cursor and Cline use the same command in their MCP settings. The documented Hermes Agent setup requires Node 18 or newer and adds the server with `hermes mcp add obsideo --command npx --args -y obsideo-mcp`.

Credentials, the signing key, and the encryption key are stored under `~/.obsideo/`. Run `backup_keys` after account creation with either a `.tar.gz` destination or a directory. The backup includes credentials, keys, and upload commitments. There is no default destination, and Obsideo cannot recover a lost encryption key.

## Tools and capabilities

- `trial`, `signup_start`, and `signup_verify` create or upgrade an account.
- `put`, `get`, `ls`, and `rm` manage stored objects.
- `verify` checks provider-held data without downloading the object.
- `usage` reports consumed and available storage and the current plan.
- `backup_keys` exports local credentials, keys, and upload commitments.
- `plan` reports free or paid status, billing period details, and pending offers.
- `upgrade` returns a Stripe checkout link for 200 GB blocks; it does not charge or resize a plan itself.
- `portal` returns a Stripe billing portal link for cancellation, payment-method changes, and invoices.

## Limitations and notes

Regan-Milne/obsideo-mcp MCP server requires careful handling of `~/.obsideo/mcp.json` and related local state. Losing the encryption key makes encrypted objects permanently unreadable. Losing `roots.json` does not remove the data, but it weakens local proof verification for affected uploads.

Encrypted objects are not described as shareable between people or machines. Select `encrypt: false` only when another tool needs to read the stored bytes directly, such as through S3-compatible access. The legacy S3 gateway remains available for older configurations or when `OBSIDEO_TRANSPORT=s3` is set; stored objects remain compatible between transport modes.

Paid storage uses 200 GB blocks through Stripe. The `upgrade` tool only produces a checkout link, and changing or cancelling billing requires human action. Cancellation keeps stored data readable until the paid period ends, after which the account returns to its free quota.

_Full upstream README: https://allmcps.com/mcp/regan-milne-obsideo-mcp/readme_

