Skip to content

docs(ai): describe cloud data-tool registration in prose, not an uninstallable import #2813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Jul 11, 2026
Merged

docs(ai): describe cloud data-tool registration in prose, not an uninstallable import #2813

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 6 additions & 15 deletions content/docs/ai/natural-language-queries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,21 +52,12 @@ model is prompted with the available objects and translates the user's question
into `query_records` calls at runtime.

<Callout type="info">
**Cloud / Enterprise — bundled in-product chat.** The cloud tier's in-UI AI
runtime (`@objectstack/service-ai`, the `ask` data-query assistant, and the
`/api/v1/ai/*` chat endpoints) registers these data tools — plus the
group-by/roll-up `aggregate_data` tool — into its chat loop via
`registerDataTools`:

```typescript
import { registerDataTools } from '@objectstack/service-ai';

ctx.hook('ai:ready', async (ai) => {
registerDataTools(ai.toolRegistry, { dataEngine: ctx.getService('data') });
});
```

This is the cloud runtime, not the open path. On the open edition, use
**Cloud / Enterprise — bundled in-product chat.** The cloud tier ships an in-UI
AI runtime (`@objectstack/service-ai`, closed) — the `ask` data-query assistant
and the `/api/v1/ai/*` chat endpoints — that registers these same data tools,
plus the group-by/roll-up `aggregate_data` tool, into its own chat loop. That
package is not part of the open framework and is documented separately in the
cloud docs; this page covers the open path only. On the open edition, use
`@objectstack/mcp` above to get the same natural-language querying with your
own AI.
</Callout>
Expand Down