Utilizing the Agentverse Mailroom feature

Introduction

The Agentverse assists you in setting up mailboxes for local and Agentverse agents, allowing them to have a two-way communication with each other without the need to be constantly online and without requiring your constant presence to operate.

To create a Mailbox, retrieve your local agent address and head over to the Agentverse: My Agents tab. Here, click on Local Agents and click on Connect Local Agent.

You will need to provide the address of the local agent you wish to retrieve and wait for confirmation. You will then need to provide a name for the agent.

Once you do so and confirm, you will see a Mailbox API Key showing up.

Copy and paste it within your local agent code by filling up the AGENT_MAILBOX_KEY field inline. Remember, each agent needs a dedicated separate mailbox!

You can then restart your local agent.

Prerequisites

Make sure you have read the following resources before going on with this guide:

Local agent setup

Let's now start by creating a local agent named alice with a handle_message() function using an @agent.on_message() decorator to handle messages received by other agents and matching the Message class:

local_agent_setup.py
 
from uagents import Agent, Context, Model
 
 
class Message(Model):
    message: str
 
 
# First generate a secure seed phrase (e.g. https://pypi.org/project/mnemonic/)
SEED_PHRASE = "put_your_seed_phrase_here"
 
# Copy the address shown below
print(f"Your agent's address is: {agent.address}")
 
# Now go to https://agentverse.ai, register your agent in the Mailroom by providing the address you just copied.
# Then, copy the agent's mailbox key and insert it here below inline
AGENT_MAILBOX_KEY = "put_your_AGENT_MAILBOX_KEY_here"
 
# Now your agent is ready to join the agentverse!
agent = Agent(
    name="alice",
    seed=SEED_PHRASE,
    mailbox=f"{AGENT_MAILBOX_KEY}@https://agentverse.ai",
)
 
 
@agent.on_message(model=Message, replies={Message})
async def handle_message(ctx: Context, sender: str, msg: Message):
    ctx.logger.info(f"Received message from {sender}: {msg.message}")
 
 
if __name__ == "__main__":
    agent.run()

You can then restart your agent; now your agent doesn't need to run all the time as their messages will be waiting for them for when they come back online.

Agentverse agent setup

Now create an Agentverse agent bob by selecting + New Agent in the My Agents tab in the Agentverse (opens in a new tab). Then, select a blank script and add the following code into it:

agentverse_agent_setup.py
 
from uagents import Agent, Context, Model
 
 
class Message(Model):
    message: str
 
 
# Copy ALICE_ADDRESS generated in mailbox_agent.py
ALICE_ADDRESS = "agent1qfa53drat8rzau90u4494gx5mhj3v87tm4t5cuzkd7gkegxcm5vx5pku7kf"
 
# Generate a second seed phrase (e.g. https://pypi.org/project/mnemonic/)
SEED_PHRASE = "put_your_seed_phrase_here"
 
# Now let's create the Agentverse agent
agent = Agent(
    name="bob",
    seed=SEED_PHRASE,
    endpoint="http://127.0.0.1:8001/submit",
)
 
 
@agent.on_interval(period=2.0)
async def send_message(ctx: Context):
    ctx.logger.info("Sending message to alice")
    await ctx.send(ALICE_ADDRESS, Message(message="hello there alice"))
 
 
@agent.on_message(model=Message, replies=set())
async def on_message(ctx: Context, sender: str, msg: Message):
    ctx.logger.info(f"Received message from {sender}: {msg.message}")
 
 
if __name__ == "__main__":
    agent.run()

Next, run bob on the Agentverse.

Expected output

You will see something like the following depending on the agent considered:

Agentverse Agent output:


2024-11-21 13:03:05	Info	Agent	Creating wrapper for preloaded 'agent' instance (Ignoring kwargs={'name': 'bob', 'seed': 'put_your_seed_phrase_here', 'endpoint': 'http://127.0.0.1:8001/submit'})
2024-11-21 13:03:05	Debug	System	Starting agent...
2024-11-21 13:03:05	Info	Agent	Sending message to alice
2024-11-21 13:03:06	Debug	System	Registered to Almanac api fast track
2024-11-21 13:03:06	Debug	System	Successfully started agent
2024-11-21 13:03:06	Info	System	Interval 0 period set to 5
2024-11-21 13:03:06	Debug	System	Registered to Almanac api fast track
2024-11-21 13:03:06	Debug	System	Envelope sent to agent1qfa53drat8rzau90u4494gx5mhj3v87tm4t5cuzkd7gkegxcm5vx5pku7kf
2024-11-21 13:03:06	Debug	System	Almanac contract registration queued for processing
2024-11-21 13:03:10	Info	Agent	Sending message to alice
2024-11-21 13:03:11	Debug	System	Envelope sent to agent1qfa53drat8rzau90u4494gx5mhj3v87tm4t5cuzkd7gkegxcm5vx5pku7kf
2024-11-21 13:03:15	Info	Agent	Sending message to alice
2024-11-21 13:03:16	Debug	System	Envelope sent to agent1qfa53drat8rzau90u4494gx5mhj3v87tm4t5cuzkd7gkegxcm5vx5pku7kf
2024-11-21 13:03:20	Info	Agent	Sending message to alice
2024-11-21 13:03:21	Debug	System	Successfully registered agent on Almanac contract

Local Agent output:


Your agent's address is: agent1qfa53drat8rzau90u4494gx5mhj3v87tm4t5cuzkd7gkegxcm5vx5pku7kf
INFO:     [alice]: Registration on Almanac API successful
INFO:     [alice]: Registering on almanac contract...
INFO:     [alice]: Registering on almanac contract...complete
INFO:     [alice]: Agent inspector available at https://agentverse.ai/inspect/?uri=http%3A//127.0.0.1%3A8000&address=agent1qfa53drat8rzau90u4494gx5mhj3v87tm4t5cuzkd7gkegxcm5vx5pku7kf
INFO:     [alice]: Starting server on http://0.0.0.0:8000 (Press CTRL+C to quit)
INFO:     [alice]: Connecting to mailbox server at agentverse.ai
INFO:     [alice]: Mailbox access token acquired
INFO:     [alice]: Received message from agent1qtr082cy3677lvrd86wzwgc3ltlmk24y5eqsu7fy946y6quh49hp2lqd5pw: hello there alice
INFO:     [alice]: Received message from agent1qtr082cy3677lvrd86wzwgc3ltlmk24y5eqsu7fy946y6quh49hp2lqd5pw: hello there alice
INFO:     [alice]: Received message from agent1qtr082cy3677lvrd86wzwgc3ltlmk24y5eqsu7fy946y6quh49hp2lqd5pw: hello there alice

Was this page helpful?

You can also leave detailed feedbackon Github

Agentverse Teams Register Agentverse Functions