Skip to content

docs: link the developer docs at futuresmart.ai/docs/database-agent #9

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
PradipNichite merged 1 commit into from
Oct 25, 2026
Merged

docs: link the developer docs at futuresmart.ai/docs/database-agent #9

Show file tree
Hide file tree
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Whether you want to explore business data, build an AI-powered application, or
adapt a complete database agent to your own requirements, you can use the
hosted application, deploy it yourself, or integrate it through its API.

**[Try the live application →](https://futuresmart.ai/solutions/database-agent)** · [Run it locally](#install) · [Explore the API](docs/api.md)
**[Try the live application →](https://futuresmart.ai/solutions/database-agent)** · [Developer docs](https://futuresmart.ai/docs/database-agent) · [Run it locally](#install) · [Explore the API](docs/api.md)

Open source · Apache-2.0 · Self-hostable

Expand All @@ -32,10 +32,13 @@ Open source · Apache-2.0 · Self-hostable
- **Use the API or customise the application.** Call the same agents from your
own software through the [direct product API](docs/api.md), or change the
open-source implementation and its [model configuration](docs/model-configuration.md).
The [developer docs](https://futuresmart.ai/docs/database-agent) cover the hosted
API end to end: quickstart, API keys, the full API reference, streaming and errors.
- **Ask from Claude Code and other MCP clients.** The included
[MCP server](docs/mcp.md) exposes your agents as tools: ask a question and get
the answer, SQL, rows and chart metadata, continue the conversation, or read
saved results.
saved results. Setup for the hosted product:
[MCP server and Claude Code](https://futuresmart.ai/docs/database-agent/mcp).

![Database Agent answering a synthetic sales question](docs/images/sales-overview.png)

Expand Down
5 changes: 5 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Direct product API

> Using the hosted product? The [developer docs](https://futuresmart.ai/docs/database-agent)
> have a quickstart, API key guidance, streaming, errors and the full
> [API reference](https://futuresmart.ai/docs/database-agent/api-reference).
> This page covers a local or self-hosted installation.

Local API root: `http://127.0.0.1:18000/nl2sql/api`.
Hosted API root: `https://futuresmart.ai/database-agent/api`, with the same routes
below and an interactive reference at
Expand Down
4 changes: 4 additions & 0 deletions docs/mcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# MCP server

> Connecting to the hosted product? Follow
> [MCP server and Claude Code](https://futuresmart.ai/docs/database-agent/mcp) in the
> developer docs. This page covers the same server against a local installation.

`mcp-server/` lets MCP-compatible AI applications, such as Claude Code, use your
Database Agent agents as tools. It is a thin adapter over the
[direct product API](api.md): every tool call is an ordinary API request made
Expand Down
Loading