From dea392ac1a2bc327e2938b9f6d81c16bfc76a7a2 Mon Sep 17 00:00:00 2001 From: Pradip Nichite <9526749+PradipNichite@users.noreply.github.com> Date: Sun, 25 Oct 2026 20:01:44 +0530 Subject: [PATCH] docs: link the developer docs at futuresmart.ai/docs/database-agent Co-Authored-By: Claude Opus 5.5 --- README.md | 7 +++++-- docs/api.md | 5 +++++ docs/mcp.md | 4 ++++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18179f0..7b82941 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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) diff --git a/docs/api.md b/docs/api.md index 80f69b4..d3b5e15 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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 diff --git a/docs/mcp.md b/docs/mcp.md index b40e351..6675ce4 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -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