🚀 MCP IPFS 服务器（storacha.network）
MCP IPFS 服务器是一款用于与 storcha.network 网络交互的工具。它基于 Node.js 和 TypeScript 构建，旨在为用户提供强大且易用的接口，实现文件存储、检索、权限管理等功能。
🚀 快速开始
MCP IPFS 服务器可帮助你轻松与 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
，其中
是要上传的文件路径。
w3_up ./my_file.txt
文件检索
使用命令：w3_get ，其中
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
📚 详细文档
注意事项
- Node.js 版本：请使用 Node.js v16 或更高版本。
- w3 CLI 安装：确保已安装
w3工具，并在$PATH中可用。 - 环境变量：设置
W3_LOGIN_EMAIL为你的 storcha.network 登录邮箱。 - 文件路径：多个
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 文件。