Bring your own Agent to the OpenBB Workspace

Welcome to the example repository for integrating custom agents into the OpenBB Workspace.

This repository provides everything you need to build and add your own custom agents that are compatible with the OpenBB Workspace.

It depends heavily on the OpenBB AI SDK.

For documentation on how to use the OpenBB AI SDK (highly recommended!), see the OpenBB AI SDK README.

[!NOTE] For a more mature OpenBB Workspace agent implementation, check out Agent Rita. It is built in TypeScript with Bun and is a useful reference for production-oriented agents.

Examples

If you prefer diving straight into code, we have a growing list of examples of custom agents in this repository, varying in complexity and features:

• A vanilla agent that can improve a user prompt

• A vanilla agent that retrieves raw widget data

• A vanilla agent that yields reasoning steps to OpenBB Workspace

• A vanilla agent that can retrieve data from OpenBB Workspace and produce citations

• A vanilla agent that can produce charts

• A vanilla agent that can produce tables

• A vanilla agent that can handle PDF data

• A vanilla agent that can handle PDF data and add citations in the document

• A vanilla agent that can access widgets on the dashboard

• A vanilla agent that has custom features

• A vanilla agent that has access to MCP tools

• A agent that shows how to access widgets from dashboard and context

These examples are a good starting point for building your own custom agent if you are interested in a specific feature or use case.