MCP Ipfs

🚀 🪐 MCP IPFS サーバー（storacha.network）🛰️

MCP IPFS サーバーは、storcha.network ネットワークとの相互作用を可能にするツールです。Node.js と TypeScript をベースに構築され、ユーザーに強力で使いやすいインターフェースを提供することを目的としています。

🚀 クイックスタート

MCP IPFS サーバーを使うことで、storcha.network ネットワーク上でのファイルの保管や検索、アクセス制御などを行うことができます。以下に、基本的な使い方を説明します。

✨ 主な機能

• ファイル保管：w3_up コマンドを使ってファイルをアップロードできます。
• ファイル検索：CID（コンテンツ識別子）を使って保管されたファイルを検索できます。
• 権限管理：委任と証明機能を通じて、細かいアクセス制御を実現します。
• コンテナ操作：IPFS コンテナの起動、停止、再起動などを管理できます。

📦 インストール

1. リポジトリをクローンします：

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

2. TypeScript コードをビルドします：

   npm run build
   

3. サーバーを起動します：

   # W3_LOGIN_EMAIL 環境変数が設定されていることを確認してください
   export W3_LOGIN_EMAIL="your-email@example.com"
   node dist/index.js
   

4. 公開する場合（権限がある場合）：

   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
  

📚 ドキュメント

📋 注意事項

⚠️ 重要提示

1. Node.js バージョン：Node.js v16 以上を使用してください。
2. w3 CLI のインストール：w3 ツールがインストールされ、$PATH で利用可能であることを確認してください。
3. 環境変数：W3_LOGIN_EMAIL を storcha.network のログインメールアドレスに設定してください。
4. ファイルパス：複数の 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 ファイルを参照してください。