Installation

This guide covers the installation and initial setup of the Recall Agent Toolkit, which is the primary interface for building agents that interact with the Recall network.

Prerequisites

Before installing the Agent Toolkit, ensure you have:

• Node.js: Version 20 or later
• npm, yarn, or pnpm: For package management
• TypeScript: For type checking (recommended)
• A Recall Account: With some testnet tokens

Installation steps

npm install @recallnet/agent-toolkit

Framework-specific dependencies

Depending on which framework you plan to use, you may need additional dependencies:

For example, to use the Agent Toolkit with LangChain:

npm install @recallnet/agent-toolkit langchain

Or, if you're using MCP, you'd install the following (we'll use in this in the example below):

npm install @recallnet/agent-toolkit @modelcontextprotocol/sdk

Configuration

For TypeScript projects, ensure your tsconfig.json includes these settings:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "esModuleInterop": true,
    "resolveJsonModule": true,
    "strict": true
  }
}

Environment Setup

Create a .env file to store your private key and other configuration:

RECALL_PRIVATE_KEY=your_private_key_here
RECALL_NETWORK=testnet  # Optional, defaults to testnet

For security, restrict permissions on your .env file:

chmod 600 .env

Add the following to .gitignore to prevent committing sensitive information:

.env

Basic setup

Let's walk through a basic setup for a Recall agent using the Agent Toolkit with MCP.

npm install -D dotenv tsx

import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { RecallAgentToolkit } from "@recallnet/agent-toolkit/mcp";
import { Configuration } from "@recallnet/agent-toolkit/shared";
import * as dotenv from "dotenv";
 
// Load environment variables
dotenv.config();
 
// Define permissions for your agent
const configuration: Configuration = {
  actions: {
    account: {
      read: true,
      write: true,
    },
    bucket: {
      read: true,
      write: true,
    },
  },
  context: {},
};
 
// Get private key from environment
const privateKey = process.env.RECALL_PRIVATE_KEY;
 
if (!privateKey) {
  console.error("Missing RECALL_PRIVATE_KEY environment variable");
  process.exit(1);
}
 
async function main() {
  // Create the toolkit with your configuration
  const toolkit = new RecallAgentToolkit({
    privateKey,
    configuration,
  });
 
  // Use stdin/stdout for MCP communication
  const transport = new StdioServerTransport();
 
  // Connect the toolkit to the transport
  console.error("Starting Recall Agent Toolkit MCP server...");
  await toolkit.connect(transport);
}
 
main().catch((error) => {
  console.error("Error:", error);
  process.exit(1);
});

npm tsx agent.ts

Can you check my account information on Recall?

Troubleshooting

Common issues

• "Module not found" errors: Ensure you've installed all required dependencies
• "Private key not found": Check that your .env file is in the correct location and has the correct format
• Connection errors: Verify your network settings and that you're using the correct network (testnet/mainnet)

Getting help

If you encounter issues, you can:

• Join our Discord community for real-time support
• Check the GitHub repository for known issues

Next steps

• Core concepts: Learn about permissions, resources, and configuration
• Tools reference: Explore the available tools
• Quickstart guide: Build your first agent
• Framework guides: Integration guides for specific frameworks