Storacha MCP 存储服务器

Storacha 热存储的 Model Context Protocol (MCP) 服务器实现，允许 AI 应用程序通过标准化接口存储和检索文件。它使用 IPFS 和 CIDs 实现无需信任、去中心化的数据交换，确保数据主权、可验证性和与代理框架及 AI 系统的无缝集成。

免费存储选项开始 🚀

今天就开始您的去中心化存储之旅！

• GitHub 用户：使用您的 GitHub 账户注册并立即获得 100MB 的免费存储空间 — 无需信用卡！
• 电子邮件用户：使用您的电子邮件注册并添加一张信用卡即可解锁 5GB 的免费存储空间。

使用场景

• 文档存储与分析：安全地上传和检索 Blob 文档。
• 长期结构化数据存储：维护优化了持久性和可访问性的结构化数据存储。
• 代理和系统之间的数据共享：使用 CIDs（内容标识符） 轻松在多个代理和不同系统之间共享数据，实现去中心化、可验证和高效的数据交换。
• 应用程序集成：通过 Model Context Protocol 无缝集成 Storacha 存储检索到应用程序中。
• AI 模型开发：通过提供可靠的版本控制和对存储在 Storacha 中的外部数据集的访问来支持 AI 模型。
• LLM 集成：通过直接连接 Storacha 存储来增强大型语言模型 (LLMs)，以实现无缝数据访问。
• Web 应用程序备份：可靠地存储 Web 应用程序的备份副本以进行灾难恢复。
• 机器学习数据集：高效管理和访问用于机器学习工作流程的大规模数据集。

快速安装指南

只需几个简单的步骤即可开始使用 Storacha MCP 存储服务器。

1. 克隆仓库

   git clone https://github.com/storacha/mcp-storage-server.git && cd mcp-storage-server
   

2. 安装依赖

   pnpm install
   

3. 生成密钥和授权

   • 安装 CLI

     npm install -g @web3-storage/w3cli
     

   • 登录 Storacha

     w3 login
     

     输出:

     ? 你想要如何登录？
       通过电子邮件
     ❯ 通过 GitHub
     

     选择 通过 GitHub 并使用你的 GitHub 账户进行认证。

   • 创建一个空间

     w3 space create <your_space_name>
     

     将 <your_space_name> 替换为你新空间的名称。:warning: 请确保保存恢复密钥，以便在需要时可以从其他设备访问你的空间。

   • 创建一个私钥

     w3 key create
     

     输出:

     AgentId: did:key:z6MkhMZRW2aoJ6BQwkpMSJu68Jgqkz1FTpr1p69cpnN43YWG
     PrivateKey: LMgCYLkvOc8Sm0mOL4cWFLxsWP0ZPEYrLxcQqsV93/s5RLje0BKx05muAse1Hkvh+sxUW38OcHtpiN1zxfpTJ4ht4jxV0=
     

   • 设置代理 ID 并创建授权

     w3 delegation create <agent_id> \
      --can 'store/add' \
      --can 'filecoin/offer' \
      --can 'upload/add' \
      --can 'space/blob/add' \
      --can 'space/index/add' --base64
     

     将 <agent_id> 替换为上一步中的 AgentId。它授予该代理将文件存储到最近创建的空间中的权限。

4. 配置 MCP 客户端

   接下来，配置你的 MCP 客户端（例如 Cursor）以使用此服务器。大多数 MCP 客户端以 JSON 格式存储配置，如下所示：

   {
     "mcpServers": {
       "storacha-storage-server": {
         "command": "node",
         "args": ["./dist/index.js"],
         "env": {
           // 服务器也支持 `sse` 模式，默认是 `stdio`。
           "MCP_TRANSPORT_MODE": "stdio",
           // 授权存储数据到空间中的 Storacha 代理私钥。
           "PRIVATE_KEY": "<agent_private_key>",
           // 证明代理被允许存储数据的基础64编码授权。如果没有设置，则每次上传请求都必须提供。
           "DELEGATION": "<base64_delegation>",
         },
         "shell": true,
         "cwd": "./",
       },
     },
   }
   

   将 <agent_private_key> 替换为步骤 3 中创建的私钥。然后，将 <base64_delegation> 替换为步骤 3 中创建的授权。

   :warning: 配置 MCP 客户端有多种方式，请阅读 integrations.md 指南获取更多信息。

工具

Storacha MCP 存储服务器提供了以下工具，供 AI 系统与去中心化存储网络交互。

存储操作

上传

将文件上传到Storacha网络。文件必须以base64编码的字符串形式提供，并且文件名需包含扩展名以便进行MIME类型检测。

interface UploadParams {
  // Base64 encoded file content
  file: string;
  // Filename with extension for MIME type detection
  name: string;
  // Optional: Whether to publish to Filecoin (default: false)
  publishToFilecoin?: boolean;
  // Optional: Custom delegation proof
  delegation?: string;
  // Optional: Custom gateway URL
  gatewayUrl?: string;
}

retrieve

从Storacha网络检索文件。支持的文件路径格式：CID/filename、/ipfs/CID/filename 或 ipfs://CID/filename。

interface RetrieveParams {
  // Path in format: CID/filename, /ipfs/CID/filename, or ipfs://CID/filename
  filepath: string;
  // Optional: Whether to use multiformat base64 encoding
  useMultiformatBase64?: boolean;
}

identity

返回从私钥存储配置中加载的Storacha代理的DIDKey。

interface IdentityParams {
  // No parameters required
}

请参阅integrations.md指南，获取详细的代码示例和不同的集成模式（SDK、Docker等）。

许可证

MIT或Apache 2许可证

支持

如需支持，请访问Storacha支持或在此仓库中提出问题。