Skip to content

Commit a2742a6

Browse files
DidierRLopesDidierRLopes
committed
move building app to agents tab
1 parent 5ed9638 commit a2742a6

7 files changed

Lines changed: 117 additions & 45 deletions

File tree

‎content/agents/app-building-skill.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: App Building Skill
3+
sidebar_position: 4
4+
description: Use the OpenBB App Builder skill to build custom OpenBB Workspace applications with an AI agent.
5+
keywords:
6+
- Agent Skills
7+
- App Builder
8+
- Custom Applications
9+
- Widget Configuration
10+
- FastAPI Backend
11+
- Dashboard Design
12+
---
13+
14+
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
15+
import GitHubMarkdown from '@site/src/components/General/GitHubMarkdown.tsx';
16+
17+
<HeadTitle title="App Building Skill | OpenBB Workspace Docs" />
18+
19+
The OpenBB App Builder skill helps agents build custom OpenBB Workspace applications, including backend endpoints, `widgets.json`, `apps.json`, dashboard layouts, and validation steps.
20+
21+
If your agent supports installable skills, install the **openbb-app-builder skill** with:
22+
23+
```bash
24+
npx skills add https://github.com/openbb-finance/backends-for-openbb --skill openbb-app-builder
25+
```
26+
27+
More information is available on the [openbb-app-builder skill page](https://skills.sh/openbb-finance/backends-for-openbb/openbb-app-builder).
28+
29+
The raw skill folder is available in the [backends-for-openbb repository](https://github.com/OpenBB-finance/backends-for-openbb/tree/66c16c8ee59aacdb562bfd9abb262d542dbe685e/.claude/skills/openbb-app-builder).
30+
31+
---
32+
33+
# Skill
34+
35+
<GitHubMarkdown url="https://github.com/OpenBB-finance/backends-for-openbb/blob/main/.claude/skills/openbb-app-builder/SKILL.md" />

‎content/workspace/developers/agent-skills.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎docusaurus.config.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,14 @@ export default {
6363
from: "/workspace/data-connector",
6464
to: "/workspace/developers/data-integration",
6565
},
66+
{
67+
from: "/workspace/developers/agent-skills",
68+
to: "/agents/app-building-skill",
69+
},
70+
{
71+
from: "/agents/building-an-app",
72+
to: "/agents/app-building-skill",
73+
},
6674
{
6775
from: "/excel/enterprise",
6876
to: "https://openbb.co/pricing",

‎sidebars.js‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ export default {
4444
id: "agents/workspace-mcp-tools",
4545
label: "Workspace MCP Tools",
4646
},
47+
{
48+
type: "doc",
49+
id: "agents/app-building-skill",
50+
label: "App Building Skill",
51+
},
4752
],
4853
},
4954
{

‎src/data/searchablePages.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,20 @@ export const searchablePages: SearchablePage[] = [
5252
"Workspace apps"
5353
]
5454
},
55+
{
56+
"title": "App Building Skill",
57+
"path": "/agents/app-building-skill",
58+
"category": "Agents",
59+
"description": "Use the OpenBB App Builder skill to build custom OpenBB Workspace applications with an AI agent.",
60+
"keywords": [
61+
"Agent Skills",
62+
"App Builder",
63+
"Custom Applications",
64+
"Widget Configuration",
65+
"FastAPI Backend",
66+
"Dashboard Design"
67+
]
68+
},
5569
{
5670
"title": "Introduction",
5771
"path": "/cli/",

‎static/agents/llms-full.txt‎

Lines changed: 54 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
1+
---
2+
title: App Building Skill
3+
sidebar_position: 4
4+
description: Use the OpenBB App Builder skill to build custom OpenBB Workspace applications with an AI agent.
5+
keywords:
6+
- Agent Skills
7+
- App Builder
8+
- Custom Applications
9+
- Widget Configuration
10+
- FastAPI Backend
11+
- Dashboard Design
12+
---
13+
14+
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
15+
import GitHubMarkdown from '@site/src/components/General/GitHubMarkdown.tsx';
16+
17+
<HeadTitle title="App Building Skill | OpenBB Workspace Docs" />
18+
19+
The OpenBB App Builder skill helps agents build custom OpenBB Workspace applications, including backend endpoints, `widgets.json`, `apps.json`, dashboard layouts, and validation steps.
20+
21+
If your agent supports installable skills, install the **openbb-app-builder skill** with:
22+
23+
```bash
24+
npx skills add https://github.com/openbb-finance/backends-for-openbb --skill openbb-app-builder
25+
```
26+
27+
More information is available on the [openbb-app-builder skill page](https://skills.sh/openbb-finance/backends-for-openbb/openbb-app-builder).
28+
29+
The raw skill folder is available in the [backends-for-openbb repository](https://github.com/OpenBB-finance/backends-for-openbb/tree/66c16c8ee59aacdb562bfd9abb262d542dbe685e/.claude/skills/openbb-app-builder).
30+
31+
---
32+
33+
# Skill
34+
35+
<GitHubMarkdown url="https://github.com/OpenBB-finance/backends-for-openbb/blob/main/.claude/skills/openbb-app-builder/SKILL.md" />
36+
37+
38+
---
39+
140
---
241
title: Workspace MCP Overview
342
sidebar_position: 1
@@ -175,6 +214,15 @@ Run the sidecar:
175214
curl -LsSf https://raw.githubusercontent.com/OpenBB-finance/workspace-mcp/main/scripts/run.sh | sh
176215
```
177216

217+
<div style={{display: 'flex', justifyContent: 'center'}}>
218+
<img
219+
className="pro-border-gradient"
220+
alt="Terminal showing the Workspace MCP sidecar running correctly"
221+
src="https://openbb-cms.directus.app/assets/2ed50bec-4bf9-4aed-99ef-9a1b7348901d.png"
222+
width="1000"
223+
/>
224+
</div>
225+
178226
The default server listens on:
179227

180228
```text
@@ -258,14 +306,6 @@ Before Workspace connects, the response should show that the sidecar is running
258306

259307
After Workspace connects, `browser_connected` should be `true` and `session` should include the current browser session metadata.
260308

261-
<div style={{display: 'flex', justifyContent: 'center'}}>
262-
<img
263-
className="pro-border-gradient"
264-
alt="Terminal showing the Workspace MCP sidecar running correctly"
265-
src="https://openbb-cms.directus.app/assets/2ed50bec-4bf9-4aed-99ef-9a1b7348901d.png"
266-
width="800"
267-
/>
268-
</div>
269309

270310
## 3. Connect Workspace to the sidecar
271311

@@ -274,8 +314,6 @@ Open OpenBB Workspace in your browser and connect the local companion:
274314
1. Open Workspace.
275315
2. Click the hamburger icon in the top-left corner.
276316
3. Open **Workspace MCP Companion**.
277-
4. Set the companion base URL to `http://127.0.0.1:8787`.
278-
5. Click the connect action after the sidecar is running.
279317

280318
<div style={{display: 'flex', justifyContent: 'center'}}>
281319
<img
@@ -286,6 +324,10 @@ Open OpenBB Workspace in your browser and connect the local companion:
286324
/>
287325
</div>
288326

327+
4. Set the companion base URL to `http://127.0.0.1:8787`.
328+
5. Click the connect action after the sidecar is running.
329+
330+
289331
<div style={{display: 'flex', justifyContent: 'center'}}>
290332
<img
291333
className="pro-border-gradient"
@@ -367,7 +409,7 @@ After the connection is working, ask the agent to read data from Workspace or ad
367409
For reading data, use a prompt like:
368410

369411
```text
370-
Read the data from the active Workspace dashboard and summarize the visible widgets.
412+
What data do you see on this dashboard and tab?
371413
```
372414

373415
<div style={{display: 'flex', justifyContent: 'center'}}>
@@ -382,7 +424,7 @@ Read the data from the active Workspace dashboard and summarize the visible widg
382424
For adding a widget, use a prompt like:
383425

384426
```text
385-
Add a widget to this Workspace dashboard using one of the available connected backends.
427+
Analyze my current portfolio exposure and add a markdown note widget with that analysis in the same tab that is open
386428
```
387429

388430
<div style={{display: 'flex', justifyContent: 'center'}}>

‎static/agents/llms.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Docs
44

5+
- [App Building Skill](https://docs.openbb.co/agents/app-building-skill): Use the OpenBB App Builder skill to build custom OpenBB Workspace applications with an AI agent.
56
- [Workspace MCP Overview](https://docs.openbb.co/agents/workspace-mcp-overview): Understand how the OpenBB Workspace MCP exposes a live Workspace browser session to external AI agents.
67
- [Workspace MCP Quickstart](https://docs.openbb.co/agents/workspace-mcp-quickstart): Run the OpenBB Workspace MCP sidecar, connect Workspace, and attach an external MCP client.
78
- [Workspace MCP Tools](https://docs.openbb.co/agents/workspace-mcp-tools): Reference for the OpenBB Workspace MCP tools, prompts, resources, parameters, and recommended calling patterns.

0 commit comments

Comments
 (0)