Skip to main content

App Builder Resources

The OpenBB app-builder instructions are maintained in the Workspace MCP repository. They help agents build custom OpenBB Workspace applications, including backend endpoints, widgets.json, apps.json, dashboard layouts, thumbnails, widget parameters, validation, and semantic output checks.

Source of truth

When your agent is connected to Workspace MCP, ask it to read the live MCP resource index:

openbb://workspace/app-builder/index

The index routes the agent to the right app-builder spec, guide, example, or validation resource for the task.

Installable skill package

For agents that support installable skills, but are not using Workspace MCP resources directly, install the generated openbb-app-builder skill from the Workspace MCP repository:

npx skills add https://github.com/OpenBB-finance/workspace-mcp --skill openbb-app-builder

This skill package is generated from the same Workspace MCP resource catalog. It is a compatibility artifact, not a separate source of truth.

Main resource entry points

TaskResource
Start any app-building taskopenbb://workspace/app-builder/index
Build a new app backendopenbb://workspace/guides/build-an-app
Review an existing appopenbb://workspace/guides/review-app
Debug a broken appopenbb://workspace/guides/debug-app
Convert an endpoint to a widgetopenbb://workspace/guides/convert-endpoint-to-widget
Edit widgets.jsonopenbb://workspace/specs/widgets-json
Edit apps.jsonopenbb://workspace/specs/apps-json
Fix validation errorsopenbb://workspace/validation/common-errors

Repository locations

Do not install the old app-builder skill from backend example repositories. Use the generated skill from workspace-mcp when a skill install is needed.