Skip to content

Add docs for cedardb cloud and the agents feature - #237

Open
lukasvogel wants to merge 2 commits into
masterfrom
vogel/ai-agents
Open

lukasvogel wants to merge 2 commits into
masterfrom
vogel/ai-agents

Conversation

@lukasvogel

Copy link
Copy Markdown
Member

No description provided.

@lukasvogel
lukasvogel requested review from a team November 12, 2026 10:15
@ChrisWint

Copy link
Copy Markdown
Contributor

There are already docs for cedardb cloud, of course not agent specific but we should not duplicate that

Split the CedarDB Cloud page into Get Started, Manage Projects,
Monitoring and Backups, and redirect its old address.
## Sign up

1. Open the [CedarDB Cloud sign-up page](https://app.cedardb.cloud/signup/).
2. Enter your details and confirm your email address.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add a note that says that people should double check spam 🙈

Comment on lines +35 to +36
Before your first project starts, also for the trial, you add a payment card.
CedarDB Cloud verifies it before it creates the project.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Before your first project starts, also for the trial, you add a payment card.
CedarDB Cloud verifies it before it creates the project.
Before your first project starts, also for the trial, you add a payment card.
CedarDB Cloud verifies it before it creates the project. We never charge your card before the end of the trial.


{{% /steps %}}

CedarDB Cloud then creates the project and starts its instance.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
CedarDB Cloud then creates the project and starts its instance.
CedarDB Cloud then creates the project and starts your database instance.


The **Connection** card on the project's **Overview** tab shows the connection string once the project runs.

![The Connection card on a project's Overview tab](/images/cloud/connection.png)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe increase font size here, this is rather hard to read from afar.


Open the project in CedarDB Cloud and go to its **Agents** tab.
Select **Switch on**.
After a moment, the status reads **Agents are on**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After a moment, the status reads **Agents are on**.
The status changes to **Agents are on** when your instance is ready for agent access.


To let agents read everything at once, select **Let it read all tables**.

![The Agents tab with table access per database and schema](/images/cloud/agents_tab.png)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also a bit hard to read, maybe larger font size would help?

Comment on lines +49 to +52

```text
https://api.app.cedardb.cloud/mcp
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be inlined


Every project starts with the user `cedar` and the database `postgres` on port `5432`.
Connect with `psql` and run a first query:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to mention that users can also regenerate there password here?

Maybe even that we create two users on startup to allow the sql executor and the connection string to run independantly and serve the user with fresh data.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i saw that you had some of the info in project. I think it makes more sense there to keep getting started brief.

It loses access to every project.
To use it again, connect it again.

**Your AI clients** also shows when each client connected and when it last queried.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revoking the access also rerolls the account password. so in case the agent fiddled with those settings and you are not sure, shutting down (or restarting) brings the access rights to a defined state.

Furthermore the agent never sees the database PW (altough it can set a new one). If you want to add a security angle.

Comment thread content/cloud/_index.md
You don't have to install, patch, or size anything yourself: create a project, connect with any PostgreSQL-compatible client, and start querying.

* [Get Started](./get_started) — sign up, create a project, and connect to it
* [Manage Projects](./manage_projects) — start, stop, reset the password, and delete a project

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for this PR, just that I thought of it now: do we want to have the — in the docs? I think we have them already, but maybe we want to eliminate them? what do you think?

Comment on lines +22 to +24
1. Open the [CedarDB Cloud sign-up page](https://app.cedardb.cloud/signup/).
2. Enter your details and confirm your email address.
3. Sign in at [app.cedardb.cloud](https://app.cedardb.cloud).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the user have to open a new site for logging in? do we not redirect with the email confirmation? Somehow it feels a bit weird to me to link the page again

2. Enter your details and confirm your email address.
3. Sign in at [app.cedardb.cloud](https://app.cedardb.cloud).

Your account comes with an organization.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is weird, maybe better:

Suggested change
Your account comes with an organization.
Your account represents your organization.

or I do not understand the meaning


Your account comes with an organization.
It groups your projects and holds your billing details and limits.
Each database you run lives in its own project, with its own storage, connection details, and backups.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to specify this really on the website? Thinking if we at somepoint want multi tenancy we would need to remove this.

Your organization's first project can run as a free trial for 30 days.
The trial runs on a Cloud I2 instance with up to 64 GiB of storage.

Before your first project starts, also for the trial, you add a payment card.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Before your first project starts, also for the trial, you add a payment card.
Before your first project starts, also for the trial, you need to add a payment card.

Comment on lines +41 to +42
If the newest backup failed, the tab says so above the backup history.
Select **Show error** next to the failed backup to see why.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is now new line before the select displayed. I think we should have one


### Confirm the restore

Type the project's name to confirm, then select **Restore backup**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a future feature, I think it would be nice to create a new instance from a backup.

Build a dashboard of daily revenue per region for the last 90 days, with a filter by product category.
```

## Switch agents on for a project

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Switch agents on for a project
## Switch agents `on` for a project


To let agents read everything at once, select **Let it read all tables**.

![The Agents tab with table access per database and schema](/images/cloud/agents_tab.png)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice to see the side bar to be able to know where this is by looking at the screenshot


### Explore and answer questions

Agents find their way around an unfamiliar schema and answer questions that would take several queries to answer by hand.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do agents not also send several queries? I think this sentence is misleading. Maybe:

Suggested change
Agents find their way around an unfamiliar schema and answer questions that would take several queries to answer by hand.
Agents find their way around an unfamiliar schema and answer questions that would be cumbersome to answer by hand as they need multiple queries.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants