🪐 MCP IPFS 服务器 (storacha.network) 🛰️

一个 Node.js 服务器，实现了 模型上下文协议 (MCP)，用于通过 w3 命令行界面 (@web3-storage/w3cli) 与 storacha.network 平台进行交互。

该服务器使语言模型 🤖 和其他 MCP 客户端能够管理 storacha.network 空间、上传/下载数据、管理委托以及执行各种其他任务，通过无缝包装 w3 命令。

✨ 功能

• 包装 w3 CLI，用于与 storacha.network 进行原生集成。
• 提供涵盖广泛 w3 功能的 MCP 工具：
  • 🔑 身份验证 & 代理: w3_login, w3_reset, w3_account_ls (用于检查授权)
  • 📦 空间管理: w3_space_ls, w3_space_use, w3_space_info, w3_space_add, w3_space_provision (注意: w3_space_create 必须手动运行，因为它需要交互式提示)
  • 💾 数据管理: w3_up, w3_ls, w3_rm
  • 🔗 共享: w3_open (生成 w3s.link URL)
  • 🤝 委托 & 证明: w3_delegation_create, w3_delegation_ls, w3_delegation_revoke, w3_proof_add, w3_proof_ls
  • 🔐 密钥 & 令牌: w3_key_create, w3_bridge_generate_tokens
  • ⚙️ 高级存储 (w3 can ...): Blob, CAR, 上传, 索引, 访问声明, Filecoin 信息管理
  • 💳 账户 & 账单: w3_plan_get, w3_coupon_create, w3_usage_report

🛠️ 前提条件

• Node.js: 22.0.0 或更高版本 (node -v)。
• w3 CLI: 该服务器直接执行 w3 命令。 确保 @web3-storage/w3cli 已全局安装并配置：

  npm install -g @web3-storage/w3cli
  w3 login <your-email@example.com>
  # 按照电子邮件验证步骤操作
  

• 环境变量: w3_login 工具需要将 W3_LOGIN_EMAIL 环境变量设置为与 w3 login 使用的电子邮件相同。

🏗️ 项目结构

代码库的组织结构如下：

src/
├── index.ts          # 主服务器入口点，MCP 设置，请求路由
├── schemas.ts        # Zod 模式，定义每个工具的输入参数
├── tool_handlers.ts  # 每个 MCP 工具的实现逻辑
├── utils.ts          # 辅助函数 (例如，运行 w3 命令，解析 JSON)
└── utils/
    └── logger.ts     # 基本的日志记录器配置

🚀 与 MCP 客户端一起使用

该服务器可以与任何 MCP 兼容的客户端一起使用。 您需要配置您的客户端以连接到此服务器。

示例: NPX (推荐用于简单的本地使用)

这假设 npm 和前提条件已满足。

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

示例: Docker

首先构建镜像 (请参阅构建部分) 或使用预构建的镜像 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"
      }
    }
  }
}

📝 关于路径的说明:

几个 w3 命令需要绝对文件系统路径 (例如, w3_up, w3_delegation_create --output, w3_proof_add, w3_can_blob_add, w3_can_store_add)。

• NPX: 提供来自您主机上的绝对路径。
• Docker: 提供 容器内部 的绝对路径。 如果与来自您主机的文件进行交互 (例如，上传)，您必须使用 -v 标志将相关的宿主机目录挂载到容器中 (例如，-v /Users/me/project:/Users/me/project)，然后在工具参数中使用 容器路径 (例如，/Users/me/project/my_file.txt)。

📦 构建

克隆存储库并安装依赖项：

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 .

📜 许可证

此 MCP 服务器在 MIT 许可证下获得许可。 有关详细信息，请参见 LICENSE 文件。