MCP Ipfs

🚀 🪐 MCP IPFS 服務器（storacha.network）🛰️

MCP IPFS 服務器是一個用於與 storcha.network 網絡交互的工具。它基於 Node.js 和 TypeScript 構建，為用戶提供了一個強大且易於使用的接口，可實現文件存儲、檢索、權限管理等功能。

🚀 快速開始

MCP IPFS 服務器能讓你輕鬆與 storcha.network 網絡進行交互。以下是使用前的準備步驟：

1. 確保你使用的是 Node.js v16 或更高版本。
2. 安裝 w3 工具，並確保其在 $PATH 中可用。
3. 設置 W3_LOGIN_EMAIL 環境變量為你的 storcha.network 登錄郵箱。

✨ 主要特性

• 文件存儲：通過 w3_up 命令上傳文件。
• 文件檢索：使用 CID（內容標識符）檢索已存儲的文件。
• 權限管理：通過委託和證明功能實現細粒度的訪問控制。
• 容器操作：管理 IPFS 容器，包括啟動、停止和重新啟動。

📦 安裝指南

克隆倉庫並安裝依賴

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

構建 TypeScript 代碼

npm run build

運行服務器

# 確保 W3_LOGIN_EMAIL 環境變量已設置
export W3_LOGIN_EMAIL="your-email@example.com"
node dist/index.js

發佈（如果你有權限）

npm publish

🐳 Docker 構建

構建 Docker 鏡像，可替換為你自己的用戶名/倉庫和所需的標籤：

docker build -t alexbakers/mcp-ipfs .

💻 使用示例

基礎用法

使用 NPX 運行

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

使用 Docker 運行

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

高級用法

工具處理

文件存儲

使用命令：w3_up <path>，其中 <path> 是要上傳的文件路徑。

w3_up ./my_file.txt

文件檢索

使用命令：w3_get <cid>，其中 <cid> 是文件的內容標識符。

w3_get Qmd5MvS7rg...

權限管理

• 委託創建：

w3_delegation create --output ./delegation.json

• 證明添加：

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

容器操作

• 啟動容器：

w3_container start

• 停止容器：

w3_container stop

• 重新啟動容器：

w3_container restart

📚 詳細文檔

注意事項

• 文件路徑：多個 w3 命令需要絕對文件路徑（例如，w3_up、w3_delegation_create --output）。
  • NPX：提供主機機器的絕對路徑。
  • Docker：提供容器內的絕對路徑。如果要與主機文件交互（例如上傳），必須使用 -v 標誌掛載主機目錄到容器，並使用容器路徑。

項目結構

src/
├── index.ts              # 入口文件
├── config.ts             # 配置管理
├── commands/             # 命令處理模塊
│   ├── up.ts            # 文件上傳命令
│   └── get.ts           # 文件獲取命令
└── utils/                # 工具函數
    └── ipfs.ts          # IPFS 操作工具

📄 許可證

MCP 服務器在 MIT 許可證下發布。有關詳細信息，請參閱 LICENSE 文件。