From 06a12dd493de6d45c63c19d66916f4ce38a6a3e3 Mon Sep 17 00:00:00 2001 From: Charles Packer Date: Fri, 3 May 2024 14:16:06 -0700 Subject: [PATCH] docs: update readme with service diagram + dev portal teaser (#1332) Co-authored-by: Sarah Wooders --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b9f046b..de172cf0 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,11 @@ MemGPT makes it easy to build and deploy stateful LLM agents with support for: * Connections to [external data sources](https://memgpt.readme.io/docs/data_sources) (e.g. PDF files) for RAG * Defining and calling [custom tools](https://memgpt.readme.io/docs/functions) (e.g. [google search](https://github.com/cpacker/MemGPT/blob/main/examples/google_search.py)) +You can also use MemGPT to depoy agents as a *service*. You can use a MemGPT server to run a multi-user, multi-agent application on top of supported LLM providers. + +image + + ## Installation & Setup Install MemGPT: ```sh @@ -42,8 +47,12 @@ You can create and chat with a MemGPT agent by running `memgpt run` in your CLI. You can view the list of available in-chat commands (e.g. `/memory`, `/exit`) in the [CLI documentation](https://memgpt.readme.io/docs/quickstart). +## Dev portal (alpha build) +MemGPT provides a developer portal that enables you to easily create, edit, monitor, and chat with your MemGPT agents. The easiest way to use the dev portal is to install MemGPT via **docker** (see instructions below). + +image + ## Quickstart (Server) -You can use MemGPT to depoy agents as a *service*. The service requires authentication with a MemGPT admin password, which can be set with running `export MEMGPT_SERVER_PASS=password`. You can start a MemGPT service in two ways: **Option 1 (Recommended)**: Run with docker compose 1. [Install docker on your system](https://docs.docker.com/get-docker/) @@ -55,7 +64,7 @@ You can use MemGPT to depoy agents as a *service*. The service requires authenti 1. Run `memgpt server` 2. Go to `localhost:8283` in the browser to view the developer portal -Once the server is running, you can use the [Python client](https://memgpt.readme.io/docs/admin-client) or [REST API](https://memgpt.readme.io/reference/api) to connect to `memgpt.localhost` (if you're running with docker compose) or `localhost:8283` (if you're running with the CLI) to create users, agents, and more. +Once the server is running, you can use the [Python client](https://memgpt.readme.io/docs/admin-client) or [REST API](https://memgpt.readme.io/reference/api) to connect to `memgpt.localhost` (if you're running with docker compose) or `localhost:8283` (if you're running with the CLI) to create users, agents, and more. The service requires authentication with a MemGPT admin password, which can be set with running `export MEMGPT_SERVER_PASS=password`. ## Supported Endpoints & Backends