Filestore

Overview

Use the Filestore MCP server from your ATXP-powered agent to store, retrieve, and delete files.

Example prompts

“Upload the file example.txt to the filestore.”
“Download the file example.txt from the filestore.”
“Delete the file example.txt from the filestore.”

Tools

filestore_write

Takes file data and saves it to the file store. For example, if you need to save a file between conversations, you can use this tool.

Arguments

Accepts a JSON object with the following properties:

string

The base64 encoded content of the file to save.

string

The URL of a file to copy contents from.

string

The content type of the file to save

string

The file extension of the file to save

boolean

Whether to make the file public.

Response

Returns a JSON object with the following properties:

string

The status of the save file operation. The status key will have the value “success” when the file is saved successfully.

string

The name of the file that was saved.

string

The URL that the file is accessible at.

filestore_read

Returns the contents of a file from the file store. For example, if you need to read a file between conversations, you can use this tool.

Arguments

Accepts a JSON object with the following properties:

string

required

The ID of the file to read.

Response

Returns a JSON object with the following properties:

string

The status of the read file operation. The status key will have the value “success” when the file is read successfully.

string

The name of the file that was read.

string

The base64 encoded content of the file that was read.

filestore_delete

Deletes a file from the file store. For example, if you need to delete a file between conversations, you can use this tool.

Arguments

Accepts a JSON object with the following properties:

string

required

The name of the file to delete.

Response

Returns a JSON object with the following properties:

string

The status of the delete file operation. The status key will have the value “success” when the file is deleted successfully.

string

The name of the file that was deleted.

Usage

Define the Filestore service

Create a reusable service configuration that points to the MCP server and standardizes how you pass arguments and read results. This lets your agent easily interact with the Filestore tools in a consistent manner.

const filestoreService = {
    mcpServer: 'https://filestore.mcp.atxp.ai/',
    writeFileToolName: 'filestore_write',
    description: 'ATXP Filestore MCP server',
    getArguments: (sourceURL: string) => ({ sourceURL }),
    getResult: (result: any) => {
      const jsonResult = result.content[0].text
      return JSON.parse(jsonResult);
    }
  };

Create an ATXP client

Using an ATXP account
Using a Base account
Using a Solana account
Using a Worldchain account
Using a Polygon account

Create a client using an ATXP account by importing the ATXP client SDK and other dependencies.

// Import the ATXP client SDK
import { atxpClient, ATXPAccount } from '@atxp/client';

// Read the ATXP account details from environment variables
const atxpConnectionString = process.env.ATXP_CONNECTION;

// Create a client using the `atxpClient` function
const client = await atxpClient({
  mcpServer: filestoreService.mcpServer,
  account: new ATXPAccount(atxpConnectionString),
});

Create a client using a Base account by importing the ATXP client SDK and other dependencies.

// Import the ATXP client SDK and Base account
import { atxpClient } from '@atxp/client';
import { BaseAccount } from '@atxp/base';

// Read the Base account details from the environment variables
const baseRpcUrl = process.env.BASE_RPC_URL;
const basePrivateKey = process.env.BASE_PRIVATE_KEY;

// Create a client using the `atxpClient` function
const client = await atxpClient({
  mcpServer: filestoreService.mcpServer,
  account: new BaseAccount(baseRpcUrl, basePrivateKey),
});

Create a client using a Solana account by importing the ATXP client SDK and other dependencies.

// Import the ATXP client SDK and Solana account
import { atxpClient } from '@atxp/client';
import { SolanaAccount } from '@atxp/solana';

// Read the Solana account details from the environment variables
const solanaRpcUrl = process.env.SOLANA_RPC_URL;
const solanaPrivateKey = process.env.SOLANA_PRIVATE_KEY;

// Create a client using the `atxpClient` function
const client = await atxpClient({
  mcpServer: filestoreService.mcpServer,
  account: new SolanaAccount(solanaRpcUrl, solanaPrivateKey),
});

Create a client using a Worldchain account with MiniKit integration.

// Import the ATXP client SDK and Worldchain account creator
import { atxpClient } from '@atxp/client';
import { createMiniKitWorldchainAccount } from '@atxp/worldchain';
import { MiniKit } from '@worldcoin/minikit-js';

// Create a Worldchain account using MiniKit
const account = await createMiniKitWorldchainAccount({
  walletAddress: '0x1234...', // User's wallet address
  miniKit: MiniKit
});

// Create a client using the `atxpClient` function
const client = await atxpClient({
  mcpServer: filestoreService.mcpServer,
  account,
});

Browser applications:

// Import the ATXP client SDK and Polygon browser account
import { atxpClient } from '@atxp/client';
import { PolygonBrowserAccount } from '@atxp/polygon';

// Initialize the Polygon browser account with wallet provider
const account = await PolygonBrowserAccount.initialize({
  provider: window.ethereum, // or any EIP-1193 provider
  walletAddress: '0x1234...', // User's wallet address
});

// Create a client using the `atxpClient` function
const client = await atxpClient({
  mcpServer: filestoreService.mcpServer,
  account,
});

Server/CLI applications:

// Import the ATXP client SDK and Polygon server account
import { atxpClient } from '@atxp/client';
import { PolygonServerAccount } from '@atxp/polygon';

// Read the Polygon account details from the environment variables
const polygonRpcUrl = process.env.POLYGON_RPC_URL;
const polygonPrivateKey = process.env.POLYGON_PRIVATE_KEY;

// Create a Polygon server account
const account = new PolygonServerAccount(
  polygonRpcUrl,
  polygonPrivateKey,
  137 // Chain ID: 137 = Polygon mainnet, 80002 = Amoy testnet
);

// Create a client using the `atxpClient` function
const client = await atxpClient({
  mcpServer: filestoreService.mcpServer,
  account,
});

Use the Filestore service in your agent

Call the Filestore tool by passing your natural-language instruction as the argument the getArguments method.Read the response using the getResult method.

const sourceURL = "https://media2.giphy.com/media/v1.Y2lkPTc5MGI3NjExN3FycXEzcnVpeDJiZnZlMThoc3R2aDdnM2NrY2hxY3J3eHFqaG92cyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/DYH297XiCS2Ck/giphy.gif"

try {
  const writeResult = await client.callTool({
      name: filestoreService.writeFileToolName,
      arguments: filestoreService.getArguments(sourceURL),
  });
  const writeResult = filestoreService.getResult(writeResult);
  console.log('Status:', writeResult.status);
  console.log('Filename:', writeResult.filename);
  console.log('URL:', writeResult.url);
} catch (error) {
  console.error(`Error with ${filestoreService.description}:`, error);
  process.exit(1);
}

You should see the result of the filestore operation printed in your console.

Overview

Web and Data

Storage

Creative

Development

Other

Overview

Example prompts

Tools

Arguments

Response

Arguments

Response

Arguments

Response

Usage

​Overview

​Example prompts

​Tools

​Arguments

​Response

​Arguments

​Response

​Arguments

​Response

​Usage

Overview

Example prompts

Tools

Arguments

Response

Arguments

Response

Arguments

Response

Usage