Skip to content

Pearl Integration Guide

This guide explains how to add your agent blueprint to Pearl App, allowing users to run your autonomous agents.

Overview

Pearl is a desktop application that allows users to run autonomous agents powered by the Olas protocol. To make your agent blueprint available in Pearl, you need to follow the integration process outlined below.

Prerequisites

Before contacting the Pearl team, ensure you have completed:

  1. Built your agent blueprint following the Olas SDK requirements
  2. Built the binaries as standalone executables following the binary building process
  3. Prepared the GitHub workflow file to build standalone binary executables following the workflow preparation guide

Request Integration

Reach out to the Pearl team to request the addition of your agent blueprint to the Pearl App.

When reaching out, please provide:

  • Link to your agent blueprint repository
  • Link to your binary releases
  • Agent blueprint details (name, description, capabilities)
  • Any specific configuration requirements

Testing Your Agent Locally (For Integrated Teams)

If you're already integrated with Pearl and want to test updates to your agent locally without requesting a dev version, follow these steps:

  1. Fork and setup Pearl: Fork the Pearl repository, follow the README guide for setup (specifically, this section), and run it locally. You may use Tenderly RPC for the needed chain in environment variables or any public RPC.

  2. Release your agent updates: Implement any necessary modifications to your agent and release it in your own repository, providing the binary, release version, and hash.

  3. Update your Pearl fork: Update the code in your Pearl fork with the new version and hash (if required) following this instruction, run the agent from Pearl locally, and conduct testing on your own.

  4. Submit for review: If the outcome is satisfactory, notify the Pearl team in the relevant channel. The team will conduct an audit, create a new version in their fork of your agent, integrate it into Pearl, perform testing, and proceed with the release.

Support

For questions or issues regarding Pearl integration, reach out on Discord.