Skip to main content

An agent framework using LLMs

Project description

Table of Contents

Mindroot

Gallery

Admin Interface

Admin Interface

Plugin Management

Plugin Management

3D Graph Visualization

3D Graph Demo

Chain Rule Explanation

Chain Rule Demo

Character Generation

Character Generation

Fantasy Character Creation

Fantasy Character

Morgan's Method

Morgan's Method

Heygen Integration Demo

Heygen Integration


PyPI

Note: some of the following is a work in progress and not yet functional. A few of them aren't really started.

Mindroot is a powerful plugin-based Python framework for creating, deploying, and sharing AI agents and related models. It offers a flexible architecture with indices and a public registry (coming soon) for easily sharing and finding plugins, agents, personas, services, knowledgebases, and apps.

Installation

You can install Mindroot using pip:

(You probably want to create a virtual environment first: python -m venv venv and source venv/bin/activate)

pip install mindroot

For development, you can install the package in editable mode:

git clone https://github.com/mindroot/mindroot.git
cd mindroot
pip install -e .

Configuration

You will need to set environment variables like JWT_SECRET_KEY (anything you want) and LLM provider keys etc.

To enable email verification: env. variable REQUIRE_EMAIL_VERIFY=true

See SMTP core plugin readme

Starting the Server

Go to the directory with the virtual environment and run:

mindroot

or if you want to start the server on a different port:

mindroot -p 8001

Note that you will always need to start from that working directory if you want your settings to be preserved.

Installing Plugins

Most of the commands or services are in plugins that you have to install. Go to the /admin page and find the Plugins section Click on the 'default' Index It should show a list of Plugins I suggest installing all of them.

The first would be either Anthropic (recommended) or OpenAI

Important: You will need either ANTHROPIC_API_KEY or OPENAI_API_KEY set in your environment variables.

To install a plugin just click the Install button and wait 10-20 seconds and you will see a confirmation pop up.

Important: You will need to restart the server to see the changes.

For now I recommend not using the Server control section on the Admin page but rather just hit Control-C in the terminal and then run mindroot again.

Developers: Creating Plugins and Tool Commands etc.

See the Plugin Documentation

Adding Commands to Agents

Go to Admin -> Agents Select an agent from the drop down, such as Assistant

There are toggle switches for all of the commands. I recommend avoiding the 'replace_' commands in files for now because they are not reliable.

Key Features:

  • Public registry for sharing and finding plugins, agents, personas, models, and knowledgebases
  • Extensible plugin architecture for adding services, commands, and building arbitrary web apps
  • Customizable AI agents with persona definitions
  • Intelligent service management based on agent requirements
  • Flexible service providers for various AI capabilities
  • Plugins can add/use hooks and pipelines such as for modifying prompts, running startup commands, or anything you want
  • Easily customizable UI built on Jinja2 and Lit Web Components
  • Support for both local and remote AI services
  • RAG: easily share, find and use pre-generated embeddings and documents for topic knowledgebases

Project details


Release history Release notifications | RSS feed

This version

3.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mindroot-3.0.1.tar.gz (8.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mindroot-3.0.1-py3-none-any.whl (9.6 MB view details)

Uploaded Python 3

File details

Details for the file mindroot-3.0.1.tar.gz.

File metadata

  • Download URL: mindroot-3.0.1.tar.gz
  • Upload date:
  • Size: 8.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.12

File hashes

Hashes for mindroot-3.0.1.tar.gz
Algorithm Hash digest
SHA256 d148a8fcf67a165ef4f3d7295b57e30951ddb9d158ffbb497618ac553ca66d71
MD5 a222fbfcd77f97da3896aa9593e93cbb
BLAKE2b-256 381be4e2a14b47625db5244ef39279b16bc301a193393f9c2ce3c4a206e32ca0

See more details on using hashes here.

File details

Details for the file mindroot-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: mindroot-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.12

File hashes

Hashes for mindroot-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82941bf724e09db8c429244edd76b84bfb82ca6510b7df52a6c6356182f50a88
MD5 f57db3469f51959faea0c2c2d8954e90
BLAKE2b-256 f32f1febb1c04ef25775b49f12fda9b10813710da0b0263f9f86e2c71d5d8e3a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page