Skip to content

Commit a16a403

Browse files
authored
Merge branch 'main' into feat/lite
2 parents f17a5b7 + 649c584 commit a16a403

7 files changed

Lines changed: 210 additions & 397 deletions

File tree

content/agents/app-builder-resources.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,43 +16,34 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
1616

1717
<HeadTitle title="App Builder Resources | OpenBB Workspace Docs" />
1818

19-
The OpenBB app-builder instructions are maintained in the
20-
[Workspace MCP repository](https://github.com/OpenBB-finance/workspace-mcp).
21-
They help agents build custom OpenBB Workspace applications, including backend
22-
endpoints, `widgets.json`, `apps.json`, dashboard layouts, thumbnails, widget
23-
parameters, validation, and semantic output checks.
19+
The OpenBB app-builder instructions are maintained in the [Workspace MCP repository](https://github.com/OpenBB-finance/workspace-mcp). 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.
2420

2521
## Source of truth
2622

27-
When your agent is connected to Workspace MCP, ask it to read the live MCP
28-
resource index:
23+
When your agent is connected to Workspace MCP, ask it to read the live MCP resource index:
2924

3025
```text
3126
openbb://workspace/app-builder/index
3227
```
3328

34-
The index routes the agent to the right app-builder spec, guide, example, or
35-
validation resource for the task.
29+
The index routes the agent to the right app-builder spec, guide, example, or validation resource for the work.
3630

3731
## Installable skill package
3832

39-
For agents that support installable skills, but are not using Workspace MCP
40-
resources directly, install the generated `openbb-app-builder` skill from the
41-
Workspace MCP repository:
33+
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:
4234

4335
```bash
4436
npx skills add https://github.com/OpenBB-finance/workspace-mcp --skill openbb-app-builder
4537
```
4638

47-
This skill package is generated from the same Workspace MCP resource catalog.
48-
It is a compatibility artifact, not a separate source of truth.
39+
This skill package is generated from the same Workspace MCP resource catalog. It is a compatibility artifact, not a separate source of truth.
4940

5041
## Main resource entry points
5142

52-
| Task | Resource |
43+
| Use case | Resource |
5344
|------|----------|
54-
| Start any app-building task | `openbb://workspace/app-builder/index` |
55-
| Build a new app backend | `openbb://workspace/guides/build-an-app` |
45+
| Start app-building work | `openbb://workspace/app-builder/index` |
46+
| Build an app backend | `openbb://workspace/guides/build-an-app` |
5647
| Review an existing app | `openbb://workspace/guides/review-app` |
5748
| Debug a broken app | `openbb://workspace/guides/debug-app` |
5849
| Convert an endpoint to a widget | `openbb://workspace/guides/convert-endpoint-to-widget` |

content/agents/workspace-mcp-overview.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
1616

1717
<HeadTitle title="Workspace MCP Overview | OpenBB Docs" />
1818

19-
The OpenBB Workspace MCP is a local companion server that exposes your active Workspace browser session as Model Context Protocol (MCP) tools. An external MCP-capable agent can use those tools to inspect dashboards, fetch widget data, create widgets, manage tabs, register backends, and instantiate Workspace apps.
19+
The OpenBB Workspace MCP lets your AI agent — Claude Code, Codex, Cursor, or any MCP-capable client — see and control your OpenBB Workspace: read the data on your dashboards, build new dashboards and widgets, and test the apps it builds.
20+
21+
It works by exposing your active Workspace browser session as Model Context Protocol (MCP) tools through a hosted backend endpoint. An external agent can use those tools to inspect dashboards, fetch widget data, create widgets, manage tabs, register backends, and instantiate Workspace apps.
2022

2123
Use it when an agent needs structured access to Workspace state. It avoids brittle browser automation because the agent calls Workspace commands directly instead of clicking through the UI.
2224

@@ -41,14 +43,14 @@ This demo shows Codex using the Workspace MCP to interact with an active OpenBB
4143

4244
## Architecture
4345

44-
The Workspace MCP runs as a local sidecar process:
46+
The Workspace MCP is served by the OpenBB backend:
4547

4648
```text
4749
MCP client or agent
4850
|
4951
| streamable HTTP MCP
5052
v
51-
Workspace MCP sidecar
53+
OpenBB backend `/mcp`
5254
|
5355
| WebSocket bridge
5456
v
@@ -59,13 +61,13 @@ OpenBB Workspace browser tab
5961
Dashboards, widgets, apps, data backends, and skills
6062
```
6163

62-
The sidecar exposes a stateless MCP endpoint at `http://127.0.0.1:8787/mcp` by default. Workspace connects to the same sidecar through a browser bridge. Tool calls sent by the agent are forwarded to the connected browser tab, executed by Workspace, and returned as structured results.
64+
OpenBB Workspace shows the hosted MCP endpoint in the Workspace MCP Companion. The endpoint path is `/mcp` on the same backend host used by Workspace. The Companion keeps your Workspace tab connected to OpenBB's servers — this connection is the browser bridge — so the agent's tool calls can reach your session. Tool calls sent by the agent are forwarded to the connected browser tab, executed by the Workspace, and returned as structured results.
6365

64-
The browser must stay open and connected. If the Workspace tab disconnects, the sidecar remains running but tool calls return an unavailable error until the browser reconnects.
66+
The browser must stay open and connected. If the Workspace tab disconnects, tool calls return an unavailable error until the browser reconnects. Each user has one active Workspace MCP bridge; connecting another browser bridge replaces the previous one.
6567

6668
## What agents can do
6769

68-
The current tool surface covers the main Workspace authoring and inspection workflows:
70+
Workspace MCP covers the main Workspace authoring and inspection workflows:
6971

7072
| Area | Examples |
7173
|------|----------|
@@ -77,7 +79,7 @@ The current tool surface covers the main Workspace authoring and inspection work
7779
| Widget authoring | Create widgets from backend definitions, update widget parameters, resize or move widgets, read widget state, and delete individual widgets. |
7880
| Generated artifacts | Add generated notes, tables, charts, and HTML widgets without a backend connection. |
7981
| Backend and app workflows | Register data backends, refresh backends, list app templates, and instantiate apps into dashboards. |
80-
| Agent and skill workflows | Delegate tasks to configured Workspace agents and load skills from the Workspace skill library. |
82+
| Agent and skill workflows | Delegate work to configured Workspace agents and load skills from the Workspace skill library. |
8183

8284
The MCP server also publishes app-builder resources under `openbb://workspace/...`. Agents can read these resources when they are building or reviewing Workspace backends, `widgets.json`, or `apps.json` files.
8385

@@ -114,21 +116,20 @@ This is useful for development workflows where the agent owns both the backend c
114116

115117
Treat any MCP client connected to the Workspace MCP as trusted. The tool server can read Workspace state and mutate dashboards in the connected browser session.
116118

117-
Keep the sidecar local:
119+
Workspace MCP uses a Workspace MCP personal access token:
118120

119-
- Bind to `127.0.0.1`, which is the default.
120-
- Do not expose it on `0.0.0.0`, a LAN address, a tunnel, or a public reverse proxy.
121-
- Use local HTTP for `localhost` or `127.0.0.1`; HTTPS is not required for the local sidecar.
121+
- Send the token as `Authorization: Bearer <token>`.
122+
- Store the token in your MCP client configuration.
123+
- Revoke the token from Workspace when it should stop working.
122124
- Connect only MCP clients you trust to read and change your Workspace.
123125

124-
The Workspace MCP operates inside an existing authenticated browser session. It does not log in for you, manage authentication tokens, change billing, change organization settings, invite users, or share dashboards.
126+
The Workspace MCP personal access token authenticates the `/mcp` endpoint only. It is not accepted by normal Workspace API routes, and it does not change billing, organization settings, user invites, or dashboard sharing.
125127

126128
## Requirements
127129

128130
- An OpenBB Workspace browser tab.
129-
- The Workspace MCP sidecar running locally.
131+
- The Workspace MCP Companion connected in Workspace.
130132
- An MCP client that can connect to a streamable HTTP MCP server.
131-
- Python 3.13 when installing or running the sidecar directly.
132-
- `uv` for the recommended install path. The helper script installs `uv` if it is not already available.
133+
- A Workspace MCP personal access token created in Workspace.
133134

134135
See [Workspace MCP Quickstart](/agents/workspace-mcp-quickstart) for setup steps and [Workspace MCP Tools](/agents/workspace-mcp-tools) for the tool reference.

0 commit comments

Comments
 (0)