mcp-ipfs

MCP搜索检索

提供方 EricGrill

搜索检索 stdio · 本地进程 未标注 社区 / 第三方 Claude DesktopClaudeZed
查看接入方式

MCP-IPFS is a Model Context Protocol server that enables AI assistants to interact directly with IPFS, providing a comprehensive suite of tools for content-addressed storage, peer-to-peer networking, and decentralized data management.

一句话选型结论

按资料字段整理

mcp-ipfs 属于搜索检索类 MCP 服务器,stdio · 本地进程,鉴权方式未标注,可直接接入 Claude Desktop、Claude、Zed,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类搜索检索 传输方式stdio · 本地进程 鉴权未标注 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

搜索检索
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

Local Deployment IPFS Decentralized Storage TypeScript Peer-to-Peer Networking Content-Addressed AI Assistant

支持客户端

适用场景

Local DeploymentIPFSDecentralized Storage

安装与配置

stdio · 本地进程 未标注
客户端在本机拉起子进程,数据不出本机
node /path/to/mcp-ipfs/dist/index.js

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 node,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
联网搜索取证

让模型查最新资料并给出出处。

资料聚合

把一个主题的网页、文档集中抓回来整理。

情报与竞品检索

按关键词持续检索行业动态和竞品信息。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Zed,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在搜索检索场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
mcp-ipfs当前 未标注 stdio · 本地进程 本地部署 有 2026-07-29
Brave Search 433812ff 2 未标注 未标注 无 2026-05-17
Sequentialthinking 1 SSE · 服务端推送 远程部署 有 2026-05-18
Baidu Netdisk 未标注 未标注 未标注 无 2026-05-17
ragflow 未标注 stdio · 本地进程 本地部署 有 2026-04-11
mindsdb (430e18) 未标注 未标注 未标注 有 2026-05-17

服务器档案

搜索检索
字段来自项目仓库与公开索引,中文说明由本站标注
提供方EricGrill上游标注的维护方 EricGrill
分类搜索检索本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式未标注远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · node本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-07-29上游最后核验时间

详细介绍

11.0 KB
来自项目仓库与上游目录的原文,未做删改

MCP-IPFS

A Model Context Protocol server for IPFS operations

Give Claude full control over the InterPlanetary File System

Quick Start •
Features •
Tools •
Configuration •
Architecture •
Contributing


What is MCP-IPFS?

MCP-IPFS is a Model Context Protocol (MCP) server that enables Claude and other AI assistants to interact directly with IPFS (InterPlanetary File System). It provides a comprehensive suite of tools for content-addressed storage, peer-to-peer networking, and decentralized data management.

Built on Helia (the modern JavaScript IPFS implementation), with a pluggable architecture ready for Kubo and remote pinning services.

Why MCP-IPFS?

Without MCP-IPFS With MCP-IPFS
Manual IPFS CLI commands Claude handles IPFS operations directly
Copy-paste CIDs between tools Seamless content-addressed workflows
No visibility into node status Full observability of peers, bandwidth, DHT
Long operations block interaction Background jobs with progress tracking
Single IPFS backend Pluggable: Helia, Kubo, pinning services

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • Claude Code CLI or any MCP-compatible client

Installation```bash

Clone the repository

git clone https://github.com/EricGrill/mcp-ipfs.git
cd mcp-ipfs

Install dependencies

npm install

Build

npm run build


### Add to Claude Code

Add to your `~/.claude/claude_desktop_config.json`:```json
{
  "mcpServers": {
    "ipfs": {
      "command": "node",
      "args": ["/path/to/mcp-ipfs/dist/index.js"]
    }
  }
}

Verify Installation```

You: What's the IPFS node status?

Claude: [Uses node_status tool]
Node is running with peer ID QmXxx...
Connected to 12 peers
Repository size: 45.2 MB


---

## ✨ Features

### 📦 Content Operations
- **Add & retrieve** text, JSON, files, directories
- **Pin management** to prevent garbage collection
- **IPNS publishing** for mutable names
- **MFS** (Mutable File System) for familiar file operations
- **DAG operations** for advanced IPLD data structures

### 🔭 Node Monitoring
- **Node identity** and health status
- **Peer connections** with latency and direction
- **Bandwidth statistics** total and per-protocol
- **Repository stats** and garbage collection
- **DHT operations** for peer/content discovery

### ⚡ Background Jobs
- **Async operations** for large files and slow networks
- **Progress tracking** with real-time updates
- **Job management** - list, poll, cancel
- **Auto-detection** - small ops return immediately

### 🔌 Pluggable Backends
- **Helia** (embedded) - zero external dependencies
- **Kubo** (planned) - connect to existing go-ipfs nodes
- **Pinning Services** (planned) - Pinata, Web3.Storage

---

## 🛠 Tools

### Content Tools

| Tool | Description |
|------|-------------|
| `ipfs_add` | Add text, JSON, or file to IPFS. Returns CID. |
| `ipfs_get` | Retrieve content by CID |
| `ipfs_pin` | Pin content to prevent garbage collection |
| `ipfs_unpin` | Unpin content |
| `ipfs_pins_list` | List all pinned CIDs |
| `ipfs_add_directory` | Add entire directory, returns root CID |
| `ipfs_ls` | List contents of directory CID |
| `ipfs_get_file` | Get specific file from directory by path |

### IPNS Tools

| Tool | Description |
|------|-------------|
| `ipns_publish` | Publish CID to IPNS name |
| `ipns_resolve` | Resolve IPNS name to current CID |
| `ipns_keys_list` | List available IPNS keys |

### MFS Tools (Mutable File System)

| Tool | Description |
|------|-------------|
| `mfs_write` | Write content to mutable path |
| `mfs_read` | Read content from MFS path |
| `mfs_ls` | List directory contents |
| `mfs_mkdir` | Create directory |
| `mfs_rm` | Remove file or directory |
| `mfs_mv` | Move/rename file or directory |
| `mfs_flush` | Flush MFS to get root CID |

### DAG Tools

| Tool | Description |
|------|-------------|
| `dag_put` | Store IPLD data, returns CID |
| `dag_get` | Retrieve IPLD node, optionally traverse path |

### Node Tools

| Tool | Description |
|------|-------------|
| `node_id` | Get peer ID, public key, versions |
| `node_status` | Quick health check |
| `node_version` | Detailed version info |
| `peers_list` | Connected peers with details |
| `peers_count` | Simple peer count |
| `bandwidth_stats` | Network bandwidth metrics |
| `swarm_connect` | Connect to peer by multiaddr |
| `swarm_disconnect` | Disconnect from peer |
| `repo_stats` | Repository statistics |
| `repo_gc` | Trigger garbage collection |

### DHT Tools

| Tool | Description |
|------|-------------|
| `dht_find_peer` | Find addresses for peer ID via DHT |
| `dht_find_providers` | Find peers providing a CID (configurable limit) |
| `dht_provide` | Announce content availability to the network |

### Job Tools

| Tool | Description |
|------|-------------|
| `job_status` | Get status of background job |
| `jobs_list` | List all jobs |
| `job_cancel` | Cancel running job |

---

## ⚙️ Configuration

### Configuration File

Create `mcp-ipfs.config.json` in the project root:```json
{
  "backend": "helia",
  "persistence": {
    "enabled": true,
    "path": "./ipfs-data"
  },
  "helia": {
    "libp2p": {
      "addresses": ["/ip4/0.0.0.0/tcp/4002"],
      "bootstrap": true
    }
  },
  "jobs": {
    "maxConcurrent": 3,
    "defaultTimeout": 300000
  }
}

Environment Variables

Environment variables override config file settings:

Variable Description Default
MCP_IPFS_BACKEND Backend to use helia
MCP_IPFS_PERSISTENCE_ENABLED Enable persistent storage true
MCP_IPFS_DATA_PATH Data directory path ./ipfs-data
MCP_IPFS_BOOTSTRAP Connect to bootstrap nodes true
MCP_IPFS_JOBS_MAX_CONCURRENT Max concurrent jobs 3
MCP_IPFS_JOBS_TIMEOUT Default job timeout (ms) 300000

Persistence Modes

Persistent (default):
- Content survives server restarts
- Uses LevelDB blockstore
- Recommended for production

In-memory:
- Content lost on restart
- Faster for testing
- Set persistence.enabled: false


🏗 Architecture```

┌─────────────────────────────────────────────────┐
│ Claude │
└─────────────────────┬───────────────────────────┘
│ MCP Protocol (JSON-RPC)
┌─────────────────────▼───────────────────────────┐
│ MCP-IPFS Server │
│ │
│ ┌───────────┐ ┌───────────┐ ┌─────────────┐ │
│ │ Content │ │ Node │ │ Job │ │
│ │ Tools │ │ Tools │ │ Manager │ │
│ └─────┬─────┘ └─────┬─────┘ └──────┬──────┘ │
│ │ │ │ │
│ └──────────────┼───────────────┘ │
│ │ │
│ ┌───────────▼───────────┐ │
│ │ Backend Layer │ │
│ │ (IPFSBackend) │ │
│ └───────────┬───────────┘ │
└───────────────────────┼─────────────────────────┘
│
┌─────────────┼─────────────┐
┌─────▼────┐ ┌─────▼────┐ ┌─────▼────┐
│ Helia │ │ Kubo │ │ Pinning │
│(embedded)│ │ API │ │ Services │
└──────────┘ └──────────┘ └──────────┘
✓ planned planned


### Key Components

| Component | Responsibility |
|-----------|----------------|
| **Content Tools** | IPFS add/get/pin, IPNS, MFS, DAG operations |
| **Node Tools** | Status, peers, bandwidth, repo, DHT, config |
| **Job Manager** | Queue long operations, track progress, enable polling |
| **Backend Layer** | Abstract IPFS implementation details |

### Backend Interface```typescript
interface IPFSBackend {
  // Lifecycle
  start(): Promise<void>;
  stop(): Promise<void>;

  // Content
  add(content: Uint8Array, options?: AddOptions): Promise<CID>;
  get(cid: CID): Promise<Uint8Array>;
  pin(cid: CID): Promise<void>;
  unpin(cid: CID): Promise<void>;

  // Node info
  id(): Promise<PeerInfo>;
  peers(): Promise<PeerConnection[]>;
  // ... etc
}

📁 Project Structure```

mcp-ipfs/
├── src/
│ ├── index.ts # Entry point
│ ├── server.ts # MCP server setup
│ ├── tools/
│ │ ├── content.ts # Content operations
│ │ ├── node.ts # Node monitoring
│ │ └── jobs.ts # Job management
│ ├── backends/
│ │ ├── interface.ts # Backend abstraction
│ │ └── helia.ts # Helia implementation
│ ├── jobs/
│ │ └── manager.ts # Job queue
│ └── config.ts # Configuration
├── test/
│ ├── content.test.ts
│ ├── node.test.ts
│ └── jobs.test.ts
├── docs/
│ └── plans/ # Design documents
├── package.json
├── tsconfig.json
└── mcp-ipfs.config.json


---

## 🧪 Development```bash
# Install dependencies
npm install

# Run in development mode
npm run dev

# Run tests
npm test

# Build for production
npm run build

# Lint
npm run lint

🤝 Contributing

Contributions are welcome! Please read our contributing guidelines before submitting PRs.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📚 Related Resources

Learn More

  • IPFS Documentation
  • Helia Documentation
  • Model Context Protocol
  • MCP TypeScript SDK

Community

  • IPFS Forums
  • IPFS Discord

📜 License

MIT License - see LICENSE for details.


🙏 Acknowledgments

  • Protocol Labs for IPFS and Helia
  • Anthropic for Claude and MCP
  • The agents-skills-plugins marketplace for inspiration

Built with ❤️ for the decentralized web

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
mcp-ipfs 怎么安装?

在客户端按下面的安装命令接入:node /path/to/mcp-ipfs/dist/index.js。装完在客户端配置里引用同一个包或端点。

mcp-ipfs 怎么在 Claude Desktop、Claude、Zed 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

mcp-ipfs 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

mcp-ipfs 需要 API Key 吗?

资料没有标注鉴权方式,是否需要密钥取决于服务本身,接入前按官方文档确认。

mcp-ipfs 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

mcp-ipfs 能提供哪些能力?

资料显示能力标签包括 Local Deployment、IPFS、Decentralized Storage、TypeScript、Peer-to-Peer Networking、Content-Addressed。具体工具清单以官方文档为准。

mcp-ipfs 需要什么运行环境?

运行时为 node;属于本地进程,需要在本机装好运行环境。

mcp-ipfs 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-07-29。