agentm
v0.7.9
Published
Command Line Interface for the AgentM Micro Agent Library
Downloads
29
Readme
AgentM
AgentM is a library of "Micro Agents" that make it easy to add reliable intelligence to any application. This tool is a Command Line Interface (CLI) that's designed to act as a companion to the agentm-core package for Node.js. At the heart of the tool is a very unique web server called "Pulse". What makes Pulse unique is that it's user interface is self modifying and 100% generated by AI. Pulse is organized into a collection of web pages that all have a chat panel that you can interact with to change to the current page. Every message results in the entire page being sent to a Large Language Model (LLM) and a new replacement page is generated. You can then save these generated pages to Pulse's page collection, letting you essentially build any sort of application structure you want. Pulse ships with a basic structure and some templates to get you started but you're free to re-form it and personalize it into any shape you want.
In addition to basic page management, the Pulse server exposes a set of API's that the LLM can leverage to create richer and more interactive experiences. A simple object store API lets the LLM store and retrieve records as JSON objects. Other API's will be added soon to support things like directly prompting the LLM and generating images using a diffusion model like DALL-E 3. The full list of available API's can be browsed using the API Explorer on the apis
page.
Beyond the built-in API's, there's a universe of JavaScript API's the LLM can leverage. The LLM will generally need to pull them from a Content Distribution Network (CDN) like . The default Pulse pages leverage a couple of libraries like D3 for charts, Marked for markdown, and Mermaid for diagrams but you're free to tell the LLM to replace these with your library of choice. I've tried a couple of animation libraries but honestly the model (gpt-4o at least) seems to do best when directly using the HTML Canvas object to draw or generate animations.
Installing AgentM
To get started using Pulse you'll need to first install a recent version of Node.js. I use version 18.20.2
but any relatively recent version should work. You'll also want to go to OpenAI.com create a developer account if you don't have one (it's free.) Once you have your account created you'll need to generate an API Key from the Dashboard. Save this key somewhere as you'll need it in a few moments.
Open a terminal window and run the following commands:
npm install --global agentm
agentm start
This will install the CLI and start the Pulse server running. This terminal window needs to stay open to keep the server running. You should see a message saying AgentM's Pulse server is running on http://localhost:4242
. You can open your browser to that link and you should land on the settings
page.
Using Pulse
The first time you open Pulse you're going to be directed to a settings
page where you can enter your API key:
Enter the OpenAI API key you saved into the API Key field and select the version of GPT-4o you'd like to use from the drop down. gpt-4o-mini
is the cheapest but it's not as creative as gpt-4o-2024-08-06
. If you're on a trial account then I'd recommend sticking with gpt-4o-mini
otherwise I'd go with gpt-4o
for the best creativity. Another strategy would be to stick with gpt-4o-mini
while using an app but switch to gpt-4o
when you want to create something new. It's also worth noting, that you only incur LLM costs when chatting with the LLM from the chat window so if you're just using an app it created, there's no cost. And if you're curious the average number of output tokens generated for a simple page is around 2,000 tokens. Add another 500 or so in prompt overhead and most requests will be around 2,500 input tokens and 2,000 generated output tokens.
Once you've entered your API key and selected your model press Update and you should be navigated to the home
page:
Type in a query like "create a snake game. make it fill the viewer and include a score" to just verify that all of your settings are properly configured and everything is working.
Page Management
A Pulse server instance is just a collection of named pages. You can think of it almost like a wiki but every page is generated by an LLM with direction from you. If you look directly above the chat input box you'll see controls for performing basic page management:
- Save - Will save the current page to either a new page or over the top of the current page. Any page can be replaced, even the home page.
- Pages - Navigates you to the
pages
page where you can see a listing of all the current pages. You can navigate to a different page from either thepages
page or by setting the/{page_name}
directly in your browsers address bar. - Reset - Restores the current page back to its last save point. The modifications to a page are cached in the servers memory until their either saved using Save or the server is restarted. Clicking Reset lets you manually roll back changes and, trust me, you will be clicking this a lot.
One thing you'll notice is that there's no Delete action. This is actually by design. The LLM has direct access to all of these page management features and I didn't want it randomly deciding to write a program that would delete all of its pages.
When you start Pulse, it creates a .agentm
subfolder under the folder it was started in. This folder contains your current settings.json
file and a .html
file for last save point of every page. Deleting this .html file will delete the page from the collection but you may need to restart the Pulse server for the changes to take effect.
Since all of the pages are just static .html files it means that you're to edit them directly using a tool like VSCode. You'll need to click Reset in the UI to see your manual changes take effect. Sometimes it's easier to just go in and tweak the final layout of a page manually.
Tips and Tricks
I'm new to working with Pulse as well but here's a couple of things I've already figured out.
Manual Reset
Sometimes the LLM will decide to make a change that breaks the entire page. This is when it's useful to know how to manually reset the page to its last save point. From the address bar append a /reset
to the current address. So https://localhost:4242/home/reset
will restore the home page back to its starting state.
Save Often
This goes along with the reset tip. Most things you create are going to take a bit of iteration. You're going to ask the LLM to make a change and it's not going to do exactly what you want or worse break the whole page. Anytime you get something you like save it. Saving is cheap and you can have as many drafts as you want. Just use a naming scheme like my_app_v2
.
Walk the LLM to a Design Step-by-Step
We're asking the LLM to re-generate an entire page on every request. That's asking a lot. You'll get your best results if you have the model focus on one change at a time (start with layout) and then step your way to a final design, saving anytime you get a result you like.
Leverage the [templates]
Use the provided templates as a starting point for structure or better yet, build your own templates! I'm still figuring this out but it seems like you want to start with defining the pages layout first because the LLM will naturally want to make any changes within the confines of the current layout. Once you get your layout the way you want add in visual elements like input boxes and such. Then once you get everything visually the way you want you can add in behavior like calling API's or saving to storage.
Give the LLM Libraries to Use
If you have a specific JavaScript library you want to use, find the link on a CDN or the web and then tell the LLM to use that specific version and it will.