MCP Ipfs

🚀 MCP IPFS Server (storacha.network)

MCP IPFS Server is a tool designed for interacting with the storcha.network. Built on Node.js and TypeScript, it offers users a powerful and user - friendly interface.

🚀 Quick Start

This section provides a quick guide on how to get started with the MCP IPFS Server.

✨ Features

• File Storage: Upload files using the w3_up command.
• File Retrieval: Retrieve stored files using CIDs (Content Identifiers).
• Permission Management: Implement fine - grained access control through delegation and proof features.
• Container Operations: Manage IPFS containers, including starting, stopping, and restarting.

📦 Installation

1. Clone the repository:

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

2. Build the TypeScript code:

   npm run build
   

3. Run the server:

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

4. Publish (if you have permission):

   npm publish
   

🐳 Docker Build

Build the Docker image:

# Replace with your own username/repository and the desired tag
docker build -t alexbakers/mcp-ipfs .

💻 Usage Examples

Basic Usage

Using NPX

npx mcp-ipfs --config ./config.json

Using Docker

docker run -i --rm -v /path/to/your/project:/path/to/your/project -e W3_LOGIN_EMAIL alexbakers/mcp-ipfs

Advanced Usage

Tool Handling

1️⃣ File Storage

• Use the command: w3_up <path>, where <path> is the path of the file to be uploaded.
• Example:

  w3_up ./my_file.txt
  

2️⃣ File Retrieval

• Use the command: w3_get <cid>, where <cid> is the content identifier of the file.
• Example:

  w3_get Qmd5MvS7rg...
  

3️⃣ Permission Management

• Create a delegation:

  w3_delegation create --output ./delegation.json
  

• Add a proof:

  w3_proof add ./my_file.txt --delegation ./delegation.json
  

4️⃣ Container Operations

• Start the container:

  w3_container start
  

• Stop the container:

  w3_container stop
  

• Restart the container:

  w3_container restart
  

📚 Documentation

Project Structure

src/
├── index.ts              # Entry file
├── config.ts             # Configuration management
├── commands/             # Command handling module
│   ├── up.ts            # File upload command
│   └── get.ts           # File retrieval command
└── utils/                # Utility functions
    └── ipfs.ts          # IPFS operation utilities

📄 License

The MCP Server is released under the MIT License. For more details, please refer to the LICENSE file.

⚠️ Important Note

1. Node.js Version: Use Node.js v16 or higher.
2. w3 CLI Installation: Ensure the w3 tool is installed and available in the $PATH.
3. Environment Variables: Set W3_LOGIN_EMAIL to your storcha.network login email.
4. File Paths: Multiple w3 commands require absolute file paths (e.g., w3_up, w3_delegation_create --output).
   • NPX: Provide the absolute path on the host machine.
   • Docker: Provide the absolute path inside the container. If you want to interact with host files (e.g., upload), you must use the -v flag to mount the host directory to the container and use the container path.