Installation
Requires Node.js 20+. MCP hosts spawn neozip-mcp from PATH — a project-local npm install is not the supported server install path.
Global install
# Once per developer machine (required)
npm install -g neozip-mcp@beta
# Verify binaries are on PATH
which neozip-mcp
which neozip-connect
neozip-connect statusDo not use these commands
| Command | Problem |
|---|---|
| npm i neozip-mcp | Missing @beta tag and -g |
| npm i neozip-mcp@beta | Local-only — binary not on PATH for MCP hosts |
Claude workspace setup
Share NeoZip MCP with your team by committing a project-scoped .mcp.json at the repository root. Anyone who clones the repo and opens it in Claude Code gets the same MCP server definition after approval.
Add workspace config (maintainer, commit to git)
Copy examples into repo
# After global install — copy examples into your repo
pkg="$(npm root -g)/neozip-mcp"
cp "$pkg/docs/examples/mcp.json.claude.example" .mcp.json
cp -R "$pkg/docs/examples/claude/skills" .claude/
# optional: cp "$pkg/docs/examples/CLAUDE.md.example" CLAUDE.md
git add .mcp.json .claude/skills CLAUDE.md
git commit -m "Add NeoZip MCP workspace config for Claude Code"Default .mcp.json — note command: "neozip-mcp" requires the global binary on PATH:
.mcp.json
{
"mcpServers": {
"neozip-mcp": {
"type": "stdio",
"command": "neozip-mcp",
"env": {
"NEOZIP_MCP_SANDBOX_PATHS": "${CLAUDE_PROJECT_DIR:-.},${HOME}"
}
}
}
}Alternative — CLI project scope
claude mcp add-json
# Alternative: Claude Code CLI creates .mcp.json for you
cd /path/to/your/project
claude mcp add-json neozip-mcp \
'{"type":"stdio","command":"neozip-mcp","env":{"NEOZIP_MCP_SANDBOX_PATHS":"${CLAUDE_PROJECT_DIR:-.},${HOME}"}}' \
--scope projectTeammate onboarding
- Clone the repository.
- Run npm install -g neozip-mcp@beta once (verify with which neozip-mcp).
- Open Claude Code in the project root: cd your-repo && claude
- Approve project MCP servers when prompted.
- Optional — for tokenize or timestamp: run neozip-connect once, then start a new session.
- Verify with claude mcp list and /mcp inside Claude Code.
Example workspace prompts
- “Zip the docs/ folder to dist/docs.nzip”
- “List entries in release.zip and summarize the README”
- “Search entries matching config and show paths”
- “Is neozip-connect ready for tokenize?”
Secrets: Never commit wallet keys or Token Service tokens in .mcp.json. Use neozip-connect per machine — credentials live in ~/.neozip/connection/.
Individual Claude Code setup
For solo developers, register NeoZip MCP at user scope so it is available in every project. You still need the global install above.
| Scope | Stored in | Who gets it | Best for |
|---|---|---|---|
| User | ~/.claude.json (top-level mcpServers) | You, all projects | Personal default on every machine |
| Local | ~/.claude.json (under this project path) | You, this project only | Private experiments |
| Project (workspace) | .mcp.json in repo root | Everyone who clones the repo | Team workspace — recommended for shared repos |
User scope + skills
# User scope — available in every project on your machine
claude mcp add-json neozip-mcp \
'{"type":"stdio","command":"neozip-mcp","env":{"NEOZIP_MCP_SANDBOX_PATHS":"${CLAUDE_PROJECT_DIR:-.},${HOME}"}}' \
--scope user
# Copy personal agent skills (once per machine)
pkg="$(npm root -g)/neozip-mcp"
mkdir -p ~/.claude/skills/neozip-mcp ~/.claude/skills/neozip-notarization
cp "$pkg/docs/examples/claude/skills/neozip-mcp/SKILL.md" ~/.claude/skills/neozip-mcp/
cp "$pkg/docs/examples/claude/skills/neozip-notarization/SKILL.md" ~/.claude/skills/neozip-notarization/Need scriptable automation outside Claude? See NeoZip CLI for JSON I/O and bundled Agent Skills.
Cursor setup
Cursor supports global or per-project mcp.json. The same global neozip-mcp binary requirement applies — install globally, then point Cursor at the command on PATH.
Cursor mcp.json excerpt
# Cursor — global or per-project mcp.json
# Same global neozip-mcp binary required on PATH
{
"mcpServers": {
"neozip-mcp": {
"command": "neozip-mcp",
"env": {
"NEOZIP_MCP_SANDBOX_PATHS": "${workspaceFolder},${userHome}"
}
}
}
}Copy the excerpt above into ~/.cursor/mcp.json or .cursor/mcp.json in your project. Optional: copy agent skills from the package into ~/.cursor/skills/.
MCP tools
Summary by category. After install, use /mcp in Claude Code to inspect the live tool list, or see the npm package page for bundled documentation.
ZIP operations
Create, inspect, and search archives without shelling out. Also exposes zip:// MCP resources for manifests and entry contents.
| Tool | Purpose |
|---|---|
| compress | Create ZIP or NeoZip archives with Zstd, Deflate, or Store; optional password, recipient, timestamp, tokenize |
| extract | Extract entries to disk within the sandbox |
| list | Paginated directory listing for LLM-friendly output |
| info | Archive metadata, compression, and integrity summary |
| test | Verify integrity entry by entry |
| read_entry | Read a single entry without full extraction (paginated) |
| search_entries | Find entries by path pattern |
| grep_entries | Search file contents inside the archive |
Blockchain
On-chain proof when neozip-connect is ready and capabilities allow. Expired Token Service tokens refresh silently via Data Wallet signature when possible.
| Tool | Purpose |
|---|---|
| mint | Mint archive content proof as an NFT |
| verify | Verify on-chain or timestamped proof |
| stamp | Submit merkle root to the NeoZip Token Service for timestamping |
| upgrade_timestamped | Upgrade pending timestamp to confirmed |
| wallet_info | Show connected wallet summary; low-balance hint points to fund_wallet |
| fund_wallet | Request a testnet gas grant (policy | status | request). request requires NEOZIP_MCP_ALLOW_FUNDING=1, confirm: true, and a testnet chain by default |
NeoZip Token Service
Account, identity, and recipient flows — requires neozip-connect setup.
| Tool | Purpose |
|---|---|
| connect_status | Check whether neozip-connect is ready (no secrets, no network) |
| token_service_status | Token Service connection and email verification state |
| token_service_register | Register with the Token Service |
| token_service_verify | Verify email with a 6-digit code |
| lookup_recipient | Look up recipient keys for encryption |
| wallet_config_status | Wallet configuration summary (no secrets) |
| identity_status | Identity key provisioning status |
Security
- Path sandboxing — NEOZIP_MCP_SANDBOX_PATHS limits which directories tools may read and write; symlink and traversal protection included.
- Capability scoping — Expose only the tool groups you want (zip, blockchain, readonly, account). Default auto adds blockchain tools after neozip-connect is ready.
- Rate and resource limits — Per-tool throttling, max file size, entry count, and operation timeouts protect against runaway agent loops.
- Local credentials — Account secrets never travel through MCP config; they live under ~/.neozip/connection/ with machine-local encryption. Expired Token Service tokens renew silently via Data Wallet signature when possible.
- Funding gates — fund_wallet request requires NEOZIP_MCP_ALLOW_FUNDING=1 and confirm: true; testnet by default unless NEOZIP_MCP_ALLOW_MAINNET_FUNDING=1.
NeoZip Connect
The neozip-connect companion CLI handles one-time account setup for tokenize, timestamp, recipient encryption, mint, and stamp. Run it once per machine — credentials stay local and are not passed through .mcp.json. After setup, reload your MCP session so blockchain tools appear.
Expired Token Service access tokens renew silently via a Data Wallet signature when possible. For testnet gas, use neozip-connect fund or the gated fund_wallet MCP tool.
Account setup
# One-time account setup (per machine)
neozip-connect
# Check status anytime
neozip-connect status
# Request a testnet gas grant (human CLI parity with fund_wallet)
neozip-connect fund status
neozip-connect fundPrefer a GUI-first identity workflow? See NeoZip Desktop and its device-held Data Wallet. CLI users can also use neozip connect.
Beta notes
- On-chain features in beta commonly use Base Sepolia testnet. Timestamps and tokenization require a one-time neozip-connect setup on each machine.
- NeoZip MCP is designed for archive, encryption, and proof workflows — not a general-purpose file manager. The server runs locally over stdio; there is no hosted remote endpoint.
- This is an early beta. Tool names, parameters, and behavior may change. Feedback helps shape the product.
- To upgrade, run npm install -g neozip-mcp@beta again and restart your MCP host session.
Looking for product overview and industry use cases?