You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: reframe getting-started around the AI build/verify loop (#2666)
* chore: bump objectui to c27bd3264f39
feat(studio): per-object API / Hooks / Actions tabs + Data-pillar polish (#2330)
objectui@c27bd3264f394bec5f5f71326118bfb115fbe884
* docs: reframe getting-started around the AI build/verify loop
Center the docs on the actual ObjectStack workflow: an AI agent (Claude Code)
authors typed metadata, a validation gate catches silent-at-runtime mistakes,
the human verifies in the visual Console, and the built app is itself AI-operable
over MCP.
- New flagship tutorial "Build with Claude Code" — the whole loop on a
live-built Support Desk app, grounded in real `os` CLI output.
- New concept page "How AI Development Works" — why the loop is fast and safe
(skills+AGENTS.md, os validate, contract-first, draft-gating, worktree).
- Repurpose the old hand-authoring Quick Start into "Anatomy of an ObjectStack
App" (read-to-verify); keep the /quick-start slug so inbound links survive.
- Front-load the "your app is an MCP server" story: env-var value-prop, a
dedicated api/index section + request-path diagram, deployment pointer.
- Reframe by real development layering (Data / Automation / Interface / Access /
AI) instead of the ObjectQL/ObjectOS/ObjectUI protocol trinity.
- Add Mermaid diagrams (build loop, AI architecture, protocol stack, MCP request
path) using the site's existing Mermaid support.
- Docs-site chrome: drop the meaningless "Documentation" self-link, fix the UI
Engine icon (deprecated `Layout` -> `LayoutDashboard`), hide the
single-language switcher.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
---------
Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: content/docs/ai/actions-as-tools.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,8 @@ description: Expose declarative Action metadata as AI-callable tools with explic
7
7
8
8
Part of the [AI module](/docs/ai) — how existing Action metadata becomes LLM-callable, and the guardrails around it.
9
9
10
+
This is what makes the app you built **AI-operable**: connect an MCP client (Claude Code, Cursor, …) and your business Actions become callable tools — so an agent can "resolve this ticket" or "convert this lead" through the same logic and permissions as the Console button.
11
+
10
12
Any business `Action` you already have — a `script` action or a Flow — can be
11
13
reached by an LLM as a callable tool. On the **open edition** this happens
12
14
through [`@objectstack/mcp`](/docs/ai): your own AI (Claude, Cursor, any MCP
Copy file name to clipboardExpand all lines: content/docs/ai/index.mdx
+11-14Lines changed: 11 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,12 @@ description: Complete guide to leveraging AI agents, RAG pipelines, and intellig
7
7
8
8
AI in ObjectStack is a **cross-protocol capability layer**: agents, tools, and knowledge retrieval sit on top of the same objects, actions, permissions, and automation that power the rest of the platform. This module covers the architecture and each of its moving parts.
9
9
10
+
<Callouttype="info">
11
+
**Two different "AI" stories — don't confuse them:**
12
+
-**AI *builds* your app** (authoring) — Claude Code writes the typed metadata; you verify in the Console. That's the [Build with Claude Code](/docs/getting-started/build-with-claude-code) workflow, in *Get Started* — a different thing from this section.
13
+
-**Your app *exposes/uses* AI** (runtime) — agents, tools, RAG, natural-language queries, and an MCP server that let an AI operate the app you built, under the same permissions. **This section covers that.**
14
+
</Callout>
15
+
10
16
<Callouttype="info">
11
17
**The open framework does AI bring-your-own-AI** — your keys, your models, zero platform AI cost. Everything on this page is part of the open edition unless a section is explicitly marked **cloud / Enterprise**:
12
18
@@ -34,20 +40,11 @@ The **cloud / Enterprise** tier adds an in-product chat *runtime* on top of thes
34
40
35
41
ObjectStack provides a comprehensive AI platform:
36
42
37
-
```
38
-
┌─────────────────────────────────────┐
39
-
│ AI Agents │ ← Persona + skills/tools
40
-
│ Skills & Tools │ ← Actions/Flows exposed to the LLM
41
-
├─────────────────────────────────────┤
42
-
│ Knowledge Protocol │ ← search_knowledge via adapters
43
-
│ - memory / ragflow / custom │
44
-
│ - Permission-aware retrieval │
45
-
├─────────────────────────────────────┤
46
-
│ Model Registry │ ← LLM management
47
-
│ - openai, azure_openai, │
48
-
│ anthropic, local │
49
-
│ - Token accounting / cost │
50
-
└─────────────────────────────────────┘
43
+
```mermaid
44
+
flowchart TD
45
+
A["<b>AI Agents</b> — persona + skills/tools"] --> T["<b>Skills & Tools</b><br/>Actions / Flows exposed to the LLM"]
46
+
T --> K["<b>Knowledge Protocol</b> — search_knowledge via adapters<br/>memory / ragflow / custom · permission-aware retrieval"]
47
+
K --> R["<b>Model Registry</b> — LLM management<br/>openai · azure_openai · anthropic · local · token accounting / cost"]
ObjectStack introduces a **Skills System** — structured, domain-specific knowledge modules that enable AI assistants (GitHub Copilot, Claude Code, Cursor, etc.) to understand and generate protocol-compliant code.
10
+
ObjectStack introduces a **Skills System** — structured, domain-specific knowledge modules that enable AI assistants (GitHub Copilot, Claude Code, Cursor, etc.) to understand and generate protocol-compliant code. Skills are what make [building with Claude Code](/docs/getting-started/build-with-claude-code) reliable: they teach the agent the protocol's rules up front, so it authors correct metadata instead of guessing.
11
11
12
12
<Callouttype="info">
13
13
Skills are **not runtime code**. They are machine-readable knowledge definitions that teach AI assistants the ObjectStack protocol — its schemas, patterns, constraints, and best practices.
@@ -186,6 +186,10 @@ Read skills/objectstack-query/SKILL.md and help me build a query
186
186
that filters opportunities by stage and aggregates revenue by quarter.
187
187
```
188
188
189
+
For the end-to-end workflow — scaffold, let Claude Code author the metadata,
190
+
validate, and verify in the Console — follow
191
+
[Build with Claude Code](/docs/getting-started/build-with-claude-code).
192
+
189
193
### With Cursor
190
194
191
195
Add the skill files to your Cursor rules or reference them in prompts:
@@ -224,4 +228,4 @@ The `evals/` directory in each skill is reserved for test cases that validate an
224
228
-[AI Skills Reference](/docs/ai/skills-reference) — Detailed guide to each skill with usage examples
225
229
-[AI Capabilities](/docs/ai) — AI agents, RAG pipelines, and intelligent automation
The architecture is built on foundational protocols that work together as a unified system:
11
11
12
+
<Callouttype="info">
13
+
**This is the engine-level view.** When you *build*, you work by area — data,
14
+
automation, interface, access, AI (see [What you build](/docs/getting-started/quick-start#what-you-build)).
15
+
This page zooms one level down, into the runtime engines that implement those areas:
16
+
**ObjectQL** (data), **ObjectOS** (control — automation, access, governance), and
17
+
**ObjectUI** (interface). You rarely think in these three while building; they're the
18
+
machinery underneath.
19
+
</Callout>
20
+
12
21
<Cards>
13
22
<Card
14
23
icon={<Database />}
@@ -48,25 +57,22 @@ Traditional applications tightly couple data, business logic, and presentation.
48
57
49
58
ObjectStack enforces **Separation of Concerns** through protocol boundaries:
50
59
60
+
```mermaid
61
+
flowchart TD
62
+
UI["<b>UI Protocol & AI Protocol</b><br/>Apps · Views · Dashboards · Agents · RAG<br/><i>How do users and agents interact?</i>"]
63
+
OS["<b>System · Automation · Cloud Protocol</b><br/>Auth · Permissions · Orchestration · Multi-tenancy<br/><i>Who / what can do what, when, and where?</i>"]
64
+
DATA["<b>Data Protocol</b><br/>Objects · Fields · Queries · Drivers<br/><i>What is the data structure?</i>"]
Metadata-driven development is a paradigm shift where **business intent is defined by declarative, analyzable metadata instead of scattered imperative code.**
11
11
12
+
<Callouttype="info">
13
+
This is also what makes ObjectStack **AI-native**: because the whole app is a few hundred
14
+
lines of typed, analyzable metadata — not tens of thousands of lines of glue — it fits in
15
+
an agent's context window. Claude Code authors it, `os validate` catches mistakes, and you
16
+
verify in the Console. See [How AI Development Works](/docs/getting-started/how-ai-development-works).
17
+
</Callout>
18
+
12
19
## The Problem with Code-First
13
20
14
21
In traditional development, the "Intent" (e.g., *"This field is a required email address"*) is scattered across multiple layers:
0 commit comments