https://github.com/storacha/mcp-storage-server
Storacha MCP storage server - self-sovereign data for your AI applications.
https://github.com/storacha/mcp-storage-server
decentralized-storage filecoin ipfs mcp-server permissionless storage trustless ucan
Last synced: 3 months ago
JSON representation
Storacha MCP storage server - self-sovereign data for your AI applications.
- Host: GitHub
- URL: https://github.com/storacha/mcp-storage-server
- Owner: storacha
- License: apache-2.0
- Created: 2025-03-21T00:09:44.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-28T13:26:00.000Z (4 months ago)
- Last Synced: 2025-06-28T14:31:59.851Z (4 months ago)
- Topics: decentralized-storage, filecoin, ipfs, mcp-server, permissionless, storage, trustless, ucan
- Language: TypeScript
- Homepage: https://storacha.ai
- Size: 491 KB
- Stars: 10
- Watchers: 3
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-servers - **mcp-storage-server** - Storacha MCP storage server - self-sovereign data for your AI applications. `typescript` `decentralized-storage` `filecoin` `ipfs` `mcp-server` `npm install storacha/mcp-storage-server` (File Management)
- awesome-mcp-servers - **mcp-storage-server** - Storacha MCP storage server - self-sovereign data for your AI applications. `typescript` `decentralized-storage` `filecoin` `ipfs` `mcp-server` `npm install storacha/mcp-storage-server` (File Management)
- mcp-index - Storacha Storage Server - Facilitates secure storage and retrieval of files using decentralized storage via IPFS and CIDs. Enables verifiable data exchange and integration with AI frameworks, offering free storage options to users. (Cloud Services)
README
# Storacha MCP Storage Server
A Model Context Protocol (MCP) server implementation for Storacha hot storage, allowing AI applications to store and retrieve files through a standardized interface. It enables trustless, decentralized data exchange using IPFS and CIDs, ensuring data sovereignty, verifiability, and seamless integration with agent frameworks & AI systems.
## Free Storage Options to Start 🚀
Jump-start your decentralized storage journey today!
- **GitHub Users**: Sign up with your GitHub account and instantly receive **100MB of free storage** — no credit card required!
- **Email Users**: Register with your email and add a credit card to unlock **5GB of free storage space**.
## Use Cases
- **Document Storage & Analysis**: Securely upload and retrieve Blob documents.
- **Long-term Structured Data Storage**: Maintain structured data storage optimized for longevity and accessibility.
- **Data Sharing Between Agents and Systems**: Easily share data across multiple agents and diverse systems using **CIDs (Content Identifiers)**, enabling decentralized, verifiable, and efficient data exchange.
- **Application Integration**: Seamlessly integrate Storacha storage retrieval into applications via the Model Context Protocol.
- **AI Model Development**: Support AI models by providing reliable versioning and access to external datasets stored in Storacha.
- **LLM Integration**: Enhance large language models (LLMs) by connecting directly with Storacha Storage for seamless data access.
- **Web Application Backups**: Reliably store backup copies of web applications for disaster recovery.
- **Machine Learning Datasets**: Efficiently manage and access large datasets used in machine learning workflows.
## Quick Installation Guide
Get started with the Storacha MCP Storage Server in just a few simple steps.
1. **Clone the Repository**
```bash
git clone https://github.com/storacha/mcp-storage-server.git && cd mcp-storage-server
```
2. **Install Dependencies**
```bash
pnpm install
```
3. **Generate Keys & Delegation**
- **Install the CLI**
```bash
npm install -g @web3-storage/w3cli
```
- **Login to Storacha**
```bash
w3 login
```
_Output:_
```
? How do you want to login?
Via Email
❯ Via GitHub
```
_Select **Via GitHub** and authenticate with your GitHub account._
- **Create a Space**
```bash
w3 space create
```
_Replace `` with a name for your new Space_. :warning: _Make sure you save the recovery key, so you can access your space from another device if needed._
- **Create a Private Key**
```bash
w3 key create
```
_Output:_
```txt
AgentId: did:key:z6MkhMZRW2aoJ6BQwkpMSJu68Jgqkz1FTpr1p69cpnN43YWG
PrivateKey: LMgCYLkvOc8Sm0mOL4cWFLxsWP0ZPEYrLxcQqsV93/s5RLje0BKx05muAse1Hkvh+sxUW38OcHtpiN1zxfpTJ4ht4jxV0=
```
- **Set the Agent ID & Create Delegation**
```bash
w3 delegation create \
--can 'store/add' \
--can 'filecoin/offer' \
--can 'upload/add' \
--can 'space/blob/add' \
--can 'space/index/add' --base64
```
_Replace with the AgentId from the previous step. It grants the Agent the permission to store files into the recently created space_.
4. **Configure the MCP Client**
Next, configure your MCP client (such as Cursor) to use this server. Most MCP clients store the configuration as JSON in the following format:
```jsonc
{
"mcpServers": {
"storacha-storage-server": {
"command": "node",
"args": ["./dist/index.js"],
"env": {
// The server supports `stdio`, `sse`, and `rest` modes, the default is `stdio`.
"MCP_TRANSPORT_MODE": "stdio",
// The Storacha Agent private key that is authorized to store data into the Space.
"PRIVATE_KEY": "",
// The base64 encoded delegation that proves the Agent is allowed to store data. If not set, MUST be provided for each upload request.
"DELEGATION": "",
},
"shell": true,
"cwd": "./",
},
},
}
```
_Replace `` with the PrivateKey you created in step 3. Then, replace the `` with the delegation you created in step 3._
### REST Mode and Cloud Hosting
The Storacha MCP Storage Server supports REST transport mode, which is compatible with MCP.so cloud hosting. To use REST mode:
```jsonc
{
"mcpServers": {
"storacha-storage-server-rest": {
"url": "http://localhost:3001/rest",
},
},
}
```
For more information on deploying to MCP.so cloud, see the [integrations.md](https://github.com/storacha/mcp-storage-server/blob/main/docs/integrations.md#mcpso-cloud-hosting) guide.
_:warning: There are several ways to configure MCP clients, please read the [integrations.md](https://github.com/storacha/mcp-storage-server/blob/main/docs/integrations.md) guide for more information._
## Tools
The Storacha MCP Storage Server provides the following tools for AI systems to interact with a decentralized storage network.
### Storage Operations
#### upload
Upload a file to the Storacha Network. The file must be provided as a base64 encoded string with a filename that includes the extension for MIME type detection.
```typescript
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
Retrieve a file from the Storacha Network. Supported filepath formats: `CID/filename`, `/ipfs/CID/filename`, or `ipfs://CID/filename`.
```typescript
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
Returns the `DIDKey` of the Storacha Agent loaded from the private key storage configuration.
```typescript
interface IdentityParams {
// No parameters required
}
```
See the [integrations.md](https://github.com/storacha/mcp-storage-server/blob/main/docs/integrations.md) guide for detailed code examples and different integration patterns (SDK, Docker, etc).
## License
MIT or Apache 2 License
## Support
For support, please visit [Storacha Support](https://storacha.network) or open an issue in this repository.
## Certifications
- [MCP Review](https://mcpreview.com/mcp-servers/storacha/mcp-storage-server)