XMTP Agent SDK Starter

A starter project for XMTP's Agent SDK to build agents that operate on the XMTP network.

Quick Start

Local Development

Create a .env file in the project root with your XMTP credentials:

XMTP_WALLET_KEY=0x...
XMTP_DB_ENCRYPTION_KEY=0x...
XMTP_ENV=production

If you do not have an existing Ethereum wallet, generate test keys at https://xmtp.github.io/agent-sdk-starter/ (keys are generated locally in your browser).

Then install dependencies and start the agent process:

npm install
npm start

After a successful start, open the test URL printed in the console and send a direct message; it should respond with the default greeting and echo your message.

If you require a sandboxed environment or do not have Node.js installed, you can run everything in GitHub Codespaces instead of locally.

GitHub Codespaces

This project includes a GitHub Codespaces configuration.

After the environment starts, launch the agent:

npm start

Deploy to Render

Render supports Persistent Disks and one-click deployments using the bundled render.yaml blueprint:

Support

Chat with xmtp-docs.eth on XMTP.chat or the Base app if you need help while developing with XMTP.