Skip to main content
Glama

πŸͺ MCP IPFS Server (storacha.network) πŸ›°οΈ

Screenshot

Publish Docker Publish NPM npm version

A Node.js server implementing the Model Context Protocol (MCP) for interacting with the storacha.network platform via the w3 command-line interface (@web3-storage/w3cli).

This server empowers language models πŸ€– and other MCP clients to manage storacha.network spaces, upload/download data, manage delegations, and perform various other tasks by seamlessly wrapping w3 commands.

✨ Features

  • Wraps the w3 CLI for native integration with storacha.network.

  • Provides MCP tools covering a wide range of w3 functionality:

    • πŸ”‘ Authentication & Agent: w3_login, w3_reset, w3_account_ls (for checking authorization)

    • πŸ“¦ Space Management: w3_space_ls, w3_space_use, w3_space_info, w3_space_add, w3_space_provision (Note: w3_space_create must be run manually due to interactive prompts)

    • πŸ’Ύ Data Management: w3_up, w3_ls, w3_rm

    • πŸ”— Sharing: w3_open (generates w3s.link URL)

    • 🀝 Delegations & Proofs: w3_delegation_create, w3_delegation_ls, w3_delegation_revoke, w3_proof_add, w3_proof_ls

    • πŸ” Keys & Tokens: w3_key_create, w3_bridge_generate_tokens

    • βš™οΈ Advanced Storage (w3 can ...): Blob, CAR, Upload, Index, Access Claim, Filecoin Info management

    • πŸ’³ Account & Billing: w3_plan_get, w3_coupon_create, w3_usage_report

Related MCP server: Swarm MCP

πŸ› οΈ Prerequisites

  • Node.js: Version 22.0.0 or higher (node -v).

  • w3 CLI: The server executes w3 commands directly. Ensure @web3-storage/w3cli is installed globally and configured:

    npm install -g @web3-storage/w3cli
    w3 login <your-email@example.com>
    # Follow email verification steps
  • Environment Variable: The w3_login tool requires the W3_LOGIN_EMAIL environment variable to be set to the same email used for w3 login.

πŸ—οΈ Project Structure

The codebase is organized as follows:

src/
β”œβ”€β”€ index.ts          # Main server entry point, MCP setup, request routing
β”œβ”€β”€ schemas.ts        # Zod schemas defining input arguments for each tool
β”œβ”€β”€ tool_handlers.ts  # Implementation logic for each MCP tool
β”œβ”€β”€ utils.ts          # Helper functions (e.g., running w3 commands, parsing JSON)
└── utils/
    └── logger.ts     # Basic logger configuration

πŸš€ Usage with MCP Clients

This server can be used with any MCP-compatible client. You need to configure your client to connect to this server.

This assumes npm and the prerequisites are met.

{
  "mcpServers": {
    "ipfs": {
      "command": "npx",
      "args": ["-y", "mcp-ipfs"],
      "env": {
        "W3_LOGIN_EMAIL": "your-email@example.com"
      }
    }
  }
}

Example: Docker

Build the image first (see Build section) or use the pre-built image alexbakers/mcp-ipfs.

{
  "mcpServers": {
    "mcp-ipfs": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-v",
        "/path/to/your/project:/path/to/your/project",
        "-e",
        "W3_LOGIN_EMAIL",
        "alexbakers/mcp-ipfs"
      ],
      "env": {
        "W3_LOGIN_EMAIL": "your-email@example.com"
      }
    }
  }
}

πŸ“ Note on Paths:

Several w3 commands require absolute filesystem paths (e.g., w3_up, w3_delegation_create --output, w3_proof_add, w3_can_blob_add, w3_can_store_add).

  • NPX: Provide absolute paths from your host machine.

  • Docker: Provide absolute paths inside the container. If interacting with files from your host (e.g., uploading), you must mount the relevant host directory into the container using the -v flag (e.g., -v /Users/me/project:/Users/me/project) and then use the container path (e.g., /Users/me/project/my_file.txt) in the tool arguments.

πŸ“¦ Build

Clone the repository and install dependencies:

git clone https://github.com/alexbakers/mcp-ipfs.git
cd mcp-ipfs
npm install

Build the TypeScript code:

npm run build

You can then run the server directly:

# Ensure W3_LOGIN_EMAIL is set in your environment
export W3_LOGIN_EMAIL="your-email@example.com"
node dist/index.js

Or publish it (if you have the rights):

npm publish

🐳 Docker Build

Build the Docker image:

# Build locally (replace with your username/repo and desired tag)
docker build -t alexbakers/mcp-ipfs .

πŸ“œ License

This MCP server is licensed under the MIT License. See the LICENSE file for details.

Available Tools

35 tools
w3_account_lsA

Lists all accounts the current agent is authorized for. Use this command after w3_login and email validation to confirm the agent is successfully linked to your storacha.network account(s). Note: Agent state may be ephemeral (e.g., in Docker). Check authorization status with this command after (re)connecting, and use w3_login if needed.

Inputs: no named parameters.

w3_bridge_generate_tokensC

Generates authentication tokens for using the UCAN-HTTP bridge.

Inputs: capabilities (required), expiration, json.

w3_can_access_claimC

Claims delegated capabilities for the authorized account using a provided proof.

Inputs: proof (required).

w3_can_blob_addC

Stores a single file as a blob directly with the service. Requires ABSOLUTE paths for file arguments.

Inputs: path (required).

w3_can_blob_lsB

Lists blobs stored in the current space.

Inputs: cursor, json, size.

w3_can_blob_rmC

Removes a blob from the store by its base58btc encoded multihash.

Inputs: multihash (required).

w3_can_filecoin_infoC

Gets Filecoin deal information for a given Piece CID (advanced use).

Inputs: pieceCid (required).

w3_can_index_addC

Registers an index CID with the service (advanced use). Please refer to storacha.network documentation for details on indices.

Inputs: cid (required).

w3_can_store_addA

Stores a CAR file with the service (advanced use). This is often a prerequisite for w3_can_upload_add. Requires ABSOLUTE paths for file arguments.

Inputs: path (required).

w3_can_store_lsC

Lists stored CAR files (shards) in the current space (advanced use).

Inputs: cursor, json, size.

w3_can_store_rmA

Removes a stored CAR shard by its CID (advanced use). Use with extreme caution, as this deletes the underlying data shard.

Inputs: carCid (required).

w3_can_upload_addA

Manually registers an upload DAG by its root CID and shard CIDs (advanced use). This is typically used after storing CAR shards manually.

Inputs: rootCid (required), shardCids (required).

w3_can_upload_lsC

Lists uploads registered in the current space (advanced view, shows underlying structure).

Inputs: cursor, json, pre, shards, +1 more.

w3_can_upload_rmA

Removes an upload listing by its root CID (advanced use). Does not remove the underlying blobs/shards.

Inputs: rootCid (required).

w3_coupon_createC

Attempts to create/claim a coupon using a claim code.

Inputs: claimCode (required).

w3_delegation_createC

Tool for w3_delegation_create operation. Requires ABSOLUTE paths for file arguments.

Inputs: audienceDid (required), capabilities (required), base64, name, +2 more.

w3_delegation_lsD

Tool for w3_delegation_ls operation.

Inputs: json.

w3_delegation_revokeC

Tool for w3_delegation_revoke operation. Requires ABSOLUTE paths for file arguments.

Inputs: delegationCid (required), proof.

w3_key_createA

Generates and prints a new ed25519 key pair. Does not automatically use it for the agent.

Inputs: json.

w3_loginA

Initiates the w3 login process using the pre-configured email (W3_LOGIN_EMAIL env var). IMPORTANT: The command expects email confirmation, so before running the w3_login tool, emphasize ATTENTION to the user in large letters + emoji that they MUST check email to complete authentication. If the final output includes 'Agent was authorized by', the user has already clicked the link and is successfully authorized, CONTINUE using mcp-ipfs tools. 'Too Many Requests': wait a moment before requesting it again.

Inputs: no named parameters.

w3_lsD

Tool for w3_ls operation.

Inputs: json.

w3_openD

Tool for w3_open operation.

Inputs: cid (required), path.

w3_plan_getB

Displays the plan associated with the current or specified account.

Inputs: accountId.

w3_proof_addC

Tool for w3_proof_add operation. Requires ABSOLUTE paths for file arguments.

Inputs: proofPath (required).

w3_proof_lsC

Tool for w3_proof_ls operation.

Inputs: json.

w3_resetA

DANGEROUS: Resets the agent state, removing all proofs and delegations but retaining the agent DID. Requires explicit confirmation argument.

Inputs: confirmReset (required).

w3_rmC

Tool for w3_rm operation.

Inputs: cid (required), removeShards.

w3_space_addD

Tool for w3_space_add operation.

Inputs: proof (required).

w3_space_createA

Creates a new space with a user-friendly name. NOTE: w3 space create cannot be run via MCP due to interactive recovery key prompts. Please run this command manually in your terminal.

Inputs: name.

w3_space_infoC

Tool for w3_space_info operation. NOTE: no current space and no space given or {"spaces":[]} first make sure you are logged in before using other tools.

Inputs: json, spaceDid.

w3_space_lsC

Tool for w3_space_ls operation. NOTE: no current space and no space given or {"spaces":[]} first make sure you are logged in before using other tools.

Inputs: no named parameters.

w3_space_provisionB

Associates a space with a customer/billing account.

Inputs: customerId (required), spaceDid (required).

w3_space_useD

Tool for w3_space_use operation.

Inputs: spaceDid (required).

w3_upC

Generates and prints a new ed25519 key pair. Does not automatically use it for the agent. Requires ABSOLUTE paths for file arguments.

Inputs: paths (required), hidden, noWrap.

w3_usage_reportB

Displays a storage usage report for the current or specified space.

Inputs: json, spaceDid.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.6/5.0

    Scored across 35 tools

    Disambiguation3/5

    The tools have overlapping purposes that could cause confusion, such as w3_can_blob_add and w3_can_store_add both handling file storage with similar requirements, and w3_key_create and w3_up both generating key pairs. However, descriptions provide some clarity, and many tools target distinct resources like accounts, spaces, and uploads, reducing ambiguity.

    Naming Consistency4/5

    Most tools follow a consistent w3_ prefix with snake_case and verb_noun patterns like w3_account_ls, w3_space_create, and w3_can_blob_add. Minor deviations exist, such as w3_up being less descriptive and some tools having vague names like w3_ls or w3_open, but overall naming is predictable and readable.

    Tool Count2/5

    With 35 tools, the count is excessive for the apparent scope of IPFS and account management, making it heavy and potentially overwhelming. A more focused set of 10-20 tools would be more appropriate, as many tools like w3_can_index_add and w3_can_upload_rm are marked as advanced use, suggesting unnecessary complexity.

    Completeness4/5

    The toolset provides comprehensive coverage for IPFS operations, including account management, file storage, space handling, and advanced features like CAR file management. Minor gaps exist, such as limited error handling tools or missing interactive commands like w3_space_create, but core workflows are well-supported with CRUD-like operations for blobs, stores, and uploads.

    Maintenance

    ActivityInactive
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      A
      quality
      C
      maintenance
      MCP server for Ethereum Swarm decentralized storage. Provides 12 tools for uploading and downloading data and files, managing postage stamp batches, and working with Swarm feeds β€” all via the Bee API. Works with the public Swarm gateway or a local Bee node.
      7
      29 npm
      9
      ISC
    • A
      license
      A
      quality
      C
      maintenance
      MCP server for the Rclone RC API. Gives AI assistants the ability to manage cloud storage remotes, copy/sync files, list directories, and more β€” all through natural language.
      56
      176 npm
      13
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      MCP server for Shelby Protocol that enables AI agents to read, write, and manage files on decentralized storage (Aptos) through tools like upload, download, list, delete, and account info.
      5
      1
      MIT