MEFS MCP Server
Officialby memoio
README.md
# MEFS-MCP-SERVER
MEMO MCP Server provides a standard storage interface for AI agents, allowing AI agents to save generated content to MEFS and providing data retrieval capabilities. It provides decentralized storage for AI agents.
## Use Cases
- Encrypted data storage: Store AI-generated content to MEFS.
- User context retrieval: Store user behavior and preference data to MEFS, and quickly retrieve relevant user data in subsequent requests to provide to AI agents.
- Seamless data sharing: AI agents can achieve trustless data sharing through content identifiers (CID).
## Free Quota
Start using mefs-storage now and enjoy 10GB of free storage space.
## Quick Installation Guide
You can follow the steps below to install the MCP server. Before using the MEFS MCP server, please ensure you have created an EVM private key.
### Prerequisites
Before using the MEFS MCP server, please ensure you have created an EVM private key. You can use EVM wallets such as [MetaMask](https://metamask.io/) or [Okx Wallet](https://web3.okx.com/) to create a wallet and obtain your private key.
### Configure MCP Server (Private Key Required)
You can start the MCP server in your client using the following configuration:
**Standard Configuration** - Suitable for most clients
```json
{
"mcpServers": {
"mefs-storage-server": {
"command": "npx",
"args": ["mefs-mcp-server"],
"env": {
"MCP_TRANSPORT_MODE": "stdio",
"MEFS_PRIVATE_KEY": "<YOUR-PRIVATE-KEY>",
},
"shell": true,
"cwd": "./",
},
},
}
```
Replace `YOUR-PRIVATE-KEY` with your EVM private key obtained from the EVM wallet.
## SSE Mode
The MEFS MCP Storage Server supports SSE transport mode. you can start sse mode with following step:
### Clone Repository
```bash
git clone https://github.com/memoio/mefs-mcp-server.git && cd mefs-mcp-server
```
### Install Dependencies
```bash
pnpm install
```
### Build
```bash
pnpm run build
```
### Start with SSE mode
```bash
pnpm run start:sse
```
You can configure `MEFS_PRIVATE_KEY` in your `.env` file, add `MEFS_PRIVATE_KEY` to your path with `export` command, or start the system using the following command to use your EVM private key:
```bash
MEFS_PRIVATE_KEY=<YOUR-PRIVATE-KEY> pnpm run start:sse
```
### Configure MCP Server (SSE mode)
```
{
"mcpServers": {
"mefs-storage-server": {
"url": "http://localhost:3001/sse",
},
},
}
```
## Using MCP Tools
MEFS MCP Server provides the following tools to interact with the decentralized storage network MEFS:
### Upload
Upload files to MEFS:
```js
// Example usage in an AI application
const result = await uploadFile({
file: base64EncodedContent,
name: "document.pdf",
});
```
Parameters:
- `file`: Base64-encoded file content
- `name`: Filename with extension
### Retrieve
Retrieve files from the MEFS network:
```javascript
// Example retrieval by CID
const document = await retrieveFile({ cid: "bafybei...gq5a/document.pdf"});
```
Parameters:
- `cid`: Unique identifier of the file
### Check Remaining Space
Check remaining storage space:
```javascript
const identity = await getSpace({});
```
TDQS
A3.7/5.0
Scored across 2 tools
Disambiguation5/5
The two tools have clearly distinct purposes: one retrieves a file by CID, the other uploads a file. There is no overlap or ambiguity.
Naming Consistency5/5
Both tool names are single lowercase verbs ('retrieve', 'upload') following a consistent pattern.
Tool Count3/5
With only two tools, the server feels thin for a storage system, but it covers the core upload and retrieve operations. It is borderline but reasonable for a very focused use case.
Completeness2/5
Obvious gaps exist: there is no tool for listing stored files, deleting files, or updating existing content. These missing operations will cause agent failures if management beyond upload/retrieve is needed.
Maintenance
ActivityInactive
ResponsivenessNo issues