Quick Start
How to get started in 3 minutes creating an Open Agent.
Last updated
How to get started in 3 minutes creating an Open Agent.
Last updated
Make sure your make-agent package is running v0.2.4+
In this guide we will:
Clone the agent template
Generate and set API Key
Develop the agent with make-agent
Deploy your agent and go live!
To get started with your Open Agent project, first clone the Bitte Next Agent Template repository. You can use this ready-to-use template as a solid foundation for building your agent
change or copy the root file .env.example to .env and add your newly generate api key
Install dependencies
Run boilerplate, this will automatically run the make-agent library + your agent server
When you run your project, the UI launches in your console, allowing you to access the chat sandbox with local dev environment connections for EVM and NEAR wallets. By testing the boilerplate with a command like "Hey, can you do a coinflip for me", you'll trigger the coinflip tool, which generates a random value.
You can customize tools by modifying their route's return value and updating the ai-plugin route manifest to define and provide LLM instructions for tool usage.
You can learn more about your manifest here: Manifest
To send transactions, return the transaction body in your route. In the manifest, specify that the route returns a valid transaction. The runtime will automatically detect this if you have the appropriate tools (generate-evm-tx or generate-transaction) defined, which are already set up in the boilerplate and prepare the transaction in the UI. Check the create-near-transaction and create-evm-transaction routes for examples
Consider pushing your code to its own GitHub repository and hosting it in a easy to deploy service like Vercel. There are other alternatives, but we find Vercel very easy to work with.
Note that your deploy script includes make-agent deploy. This command will validate your API key, look into the deployment URL (for most common hosting providers) and automatically communicate any changes made to our registry.
In case you want to have more control over your deployment URL, you can set BITTE_AGENT_URL
make-agent is a CLI tool that was built to make the development of an Open Agent as easy as possible-
The templates should have these packages installed. But if you're trying to add this to an existing project, please install make-agent and concurrently.
Your package.json should look like this:
You can now run in development mode.
Learn more about the Manifest file by following the link below.
