Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
a52c271
chore: more migration.
billy-the-fish Sep 17, 2025
b1b0f09
chore: updates on review.
billy-the-fish Nov 3, 2025
bef5e1a
Merge branch 'main' of github.com:timescale/documentation into 400-mi…
billy-the-fish Nov 3, 2025
c38b45f
Merge branch '400-migration-branch' of github.com:timescale/documenta…
billy-the-fish Nov 3, 2025
89f5c56
chore: first step on the hyperfunctions
billy-the-fish Nov 5, 2025
f4530ff
chore: last hyperfunctions
billy-the-fish Nov 6, 2025
96395fe
chore: hypertable
billy-the-fish Nov 6, 2025
fbaeb28
chore: hypertable
billy-the-fish Nov 6, 2025
58cabf4
chore: add the snippets
billy-the-fish Nov 7, 2025
4447dbf
chore: more edits
billy-the-fish Nov 7, 2025
3720164
chore: variables and PGAI
billy-the-fish Nov 9, 2025
43680e3
chore: pgvectorscale
billy-the-fish Nov 9, 2025
91c4daf
chore: variables
billy-the-fish Nov 9, 2025
71b8cea
chore: more migration.
billy-the-fish Nov 11, 2025
b58f750
Merge branch '369-migrate-the-timescaledb-api-ref-to-mintlify' of git…
billy-the-fish Nov 11, 2025
d7ebe0e
chore: more migration.
billy-the-fish Nov 11, 2025
794cdff
chore: code checks
billy-the-fish Nov 11, 2025
cb68ce1
chore: cleanup
billy-the-fish Nov 11, 2025
638deaa
With menus (#16)
billy-the-fish Nov 13, 2025
11ae0dd
chore: add Agentic Postgres to the landing page
billy-the-fish Nov 13, 2025
d5027df
chore: rename :-).
billy-the-fish Nov 13, 2025
998118a
update for text wrapping in tables
atovpeko Nov 17, 2025
4a21c53
chore: remove extra sentences in api features list.
billy-the-fish Nov 17, 2025
fe3395c
chore: move api category.
billy-the-fish Nov 17, 2025
0dcaa1e
chore: old and deprecated.
billy-the-fish Nov 17, 2025
f5ab912
chore: cleanup
billy-the-fish Nov 17, 2025
ac6e8de
chore: update materialized view arguments table
billy-the-fish Nov 17, 2025
4f95c42
Update api-reference/timescaledb/continuous-aggregates/drop_materiali…
billy-the-fish Nov 17, 2025
3836a6d
chore: updates
billy-the-fish Nov 17, 2025
e4e8fa0
chore: Samples before arguments in the API ref.
billy-the-fish Nov 17, 2025
7400f2a
update for missing functions
atovpeko Nov 18, 2025
342b18b
chore: add syntax, sort out returns for hyperfunctions.
billy-the-fish Nov 18, 2025
1debf47
chore: cleanup.
billy-the-fish Nov 18, 2025
4eaa45c
chore: ugly workaround for listing .
billy-the-fish Nov 18, 2025
9c08cf3
chore: add syntax.
billy-the-fish Nov 18, 2025
09974ee
chore: remove dead cards.
billy-the-fish Nov 18, 2025
24c8d75
text wrapping
atovpeko Nov 20, 2025
84facdd
update for missing columns
atovpeko Nov 24, 2025
bffee0e
chore: Update nav to have full dropdowns.
billy-the-fish Nov 24, 2025
37fbbe6
chore: Update nav for diff structure.
billy-the-fish Nov 25, 2025
723ed95
Merge branch 'main' into chore/assistant-test
robsoncoelho Nov 27, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ dist

# vuepress v2.x temp and cache directory
.temp

n
# Sveltekit cache directory
.svelte-kit/

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Each major doc section has a dedicated directory with `.md` files inside, repres
- An argument table with `Name`, `Type`, `Default`, `Required`, `Description` columns.
- A return table with `Column`, `Type`, and `Description` columns.

- **Troubleshooting pages** are not written as whole Markdown files, but are programmatically assembled from individual files in the`_troubleshooting` folder. Each entry describes a single troubleshooting case and its solution, and contains the following front matter:
- **Troubleshoot pages** are not written as whole Markdown files, but are programmatically assembled from individual files in the`_troubleshooting` folder. Each entry describes a single troubleshooting case and its solution, and contains the following front matter:

|Key| Type |Required| Description |
|-|-------|-|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down Expand Up @@ -69,7 +69,7 @@ The navigation hierarchy of a doc section is governed by `page-index/page-index.
excerpt: "Tiger Cloud services explorer",
},
{
title: "Troubleshooting Tiger Cloud services",
title: "Troubleshoot Tiger Cloud services",
href: "troubleshooting",
type: "placeholder",
},
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://assets.timescale.com/docs/images/tigerdata-gradient-white.svg" />
<source media="(prefers-color-scheme: light)" srcset="https://assets.timescale.com/docs/images/tigerdata-gradient-black.svg" />
<source media="(prefers-color-scheme: dark)" srcset="https://assets.timescale.com/timescale-web/brand/show/horizontal-white.svg" />
<source media="(prefers-color-scheme: light)" srcset="https://assets.timescale.com/timescale-web/brand/show/horizontal-black.svg" />
<img alt="Tiger Data logo" src="https://assets.timescale.com/docs/images/tigerdata-gradient-black.svg" />
</picture>
</div>
Expand Down Expand Up @@ -62,4 +62,3 @@ Tiger Data is Postgres made powerful. To learn more about the company and its pr
[github-fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
[github-clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
[gatsby]: https://www.gatsbyjs.com/
</div>
223 changes: 223 additions & 0 deletions agentic-postgres/agents/mcp-server.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
---
title: Integrate Tiger Cloud with your AI Assistant

Check warning on line 2 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L2

Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.
description: Manage your services and optimize your schema and queries using your AI Assistant
products: [cloud, self_hosted]
keywords: [ai, mcp, server, security]
tags: [ai]
---

import RESTPrereqs from '/snippets/prerequisites/_prereqs-cloud-account-only.mdx';

Check warning on line 9 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L9

Did you really mean 'RESTPrereqs'?

Check warning on line 9 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L9

Use semicolons judiciously.
import CLIINSTALL from '/snippets/devops/_devops-cli-install.mdx';

Check warning on line 10 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L10

Use semicolons judiciously.
import MCPCOMMANDS from '/snippets/devops/_devops-mcp-commands.mdx';

Check warning on line 11 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L11

Use semicolons judiciously.
import MCPCOMMANDSCLI from '/snippets/devops/_devops-mcp-commands-cli.mdx';

Check warning on line 12 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L12

Use semicolons judiciously.
import GLOBALFLAGS from '/snippets/devops/_devops-cli-global-flags.mdx';

Check warning on line 13 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L13

Use semicolons judiciously.
import { MCP_LONG, MCP_SHORT, CLI_LONG, CLI_SHORT, CLOUD_LONG, ACCOUNT_LONG, PROJECT_SHORT, SERVICE_SHORT, SERVICE_LONG, COMPANY } from '/snippets/vars.mdx';

Check warning on line 14 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L14

Use semicolons judiciously.


{MCP_LONG} provides access to your {CLOUD_LONG} resources through Claude and other AI Assistants. {MCP_SHORT}
mirrors the functionality of {CLI_LONG} and is integrated directly into the {CLI_SHORT} binary. You manage your

Check warning on line 18 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L18

Use 'capability' or 'feature' instead of 'functionality'.

Check warning on line 18 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L18

In general, use active voice instead of passive voice ('is integrated').
{CLOUD_LONG} resources using natural language from your AI Assistant. As {MCP_SHORT} is integrated with the

Check warning on line 19 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L19

In general, use active voice instead of passive voice ('is integrated').
{COMPANY} documentation, ask any question and you will get the best answer.

Check warning on line 20 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L20

Avoid using 'will'.

This page shows you how to install {CLI_LONG} and set up secure authentication for {MCP_SHORT}, then manage the
resources in your {ACCOUNT_LONG} through {MCP_LONG} using your AI Assistant.

## Prerequisites

<RESTPrereqs />

- Install an AI Assistant on your developer device with an active API key.

The following AI Assistants are automatically configured by {MCP_LONG}: `claude-code`, `cursor`, `windsurf`, `codex`, `gemini/gemini-cli`, `vscode/code/vs-code`.
You can also [manually configure][manual-config] {MCP_SHORT}.

## Install and configure {MCP_SHORT}

Check warning on line 34 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L34

'Install and configure {MCP_SHORT}' should use sentence-style capitalization.

{MCP_SHORT} is bundled with {CLI_LONG}:

Check warning on line 36 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L36

In general, use active voice instead of passive voice ('is bundled').

<CLIINSTALL />

1. **Configure your AI Assistant to interact with the {PROJECT_SHORT} and {SERVICE_SHORT}s in your {ACCOUNT_LONG}**

For example:
```shell
tiger mcp install
```

1. **Choose the client to integrate with, then press `Enter` **

```shell
Select an MCP client to configure:

> 1. Claude Code
2. Codex
3. Cursor
4. Gemini CLI
5. VS Code
6. Windsurf

Use ↑/↓ arrows or number keys to navigate, enter to select, q to quit
```

And that is it, you are ready to use {MCP_LONG} to manage your {SERVICE_SHORT}s in {CLOUD_LONG}.

Check warning on line 62 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L62

Use 'that's' instead of 'that is'.

## Manage the resources in your {ACCOUNT_LONG} through your AI Assistant

Your AI Assistant is connected to your {ACCOUNT_LONG} and the {COMPANY} documentation, you can now use it to

Check warning on line 66 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L66

In general, use active voice instead of passive voice ('is connected').
manage your {SERVICE_SHORT}s and learn more about how to implement {CLOUD_LONG} features. For example:

1. **Run your AI Assistant**
```shell
claude
```
Claude automatically runs {MCP_SHORT} server that enables you to interact with {CLOUD_LONG} from your
AI Assistant.

1. **Check your {MCP_LONG} configuration**
```shell
> is the tigerdata mcp server active for you?
```
You see something like:
```shell
MCP server is active. I can see the following Tiger Data-related tools available:

- mcp__tiger__get_guide - Retrieve TimescaleDB guides and best practices
- mcp__tiger__semantic_search_postgres_docs - Search PostgreSQL documentation
- mcp__tiger__semantic_search_tiger_docs - Search Tiger Cloud and TimescaleDB documentation
- mcp__tiger__tiger_service_create - Create new database services
- mcp__tiger__tiger_service_list - List all database services
- mcp__tiger__tiger_service_show - Show detailed service information
- mcp__tiger__tiger_service_update_password - Update service passwords

Is there something specific you'd like to do with the Tiger Data MCP server?
```

1. **Ask a basic question about your {SERVICE_SHORT}s**
```shell
> can you list my active services please
```
You see something like:
```shell
⏺ You have 3 active services, all with the same name "my-first-service":

1. tgrservice1 - READY - TimescaleDB - us-east-1 - 1 CPU/4GB - Created: 2025-09-30
2. tgrservice1 - READY - TimescaleDB - us-east-1 - 1 CPU/4GB - Created: 2025-09-30
3. tgrservice1 - READY - TimescaleDB - us-east-1 - 1 CPU/4GB - Created: 2025-09-30
```

1. **Manage your {SERVICE_SHORT}s without having to learn how to**

For example:
```shell
Can you create a new ai service called bob with a replica for me please
```
You see something like:
```shell
tiger - Create Database Service (MCP)(name: "bob", addons: ["ai"], replicas: 1, wait: false)
```

1. **Find best practice for things you need to do**

For example:
```shell
> I need to migrate a database with 25 million rows of data to Tiger Cloud,
please tell me what service optimizations i should do before migration.

```

You see something like:

```shell
⏺ For migrating a database with 25 million rows to Tiger Cloud, here are the key service optimizations to do before migration:

Pre-Migration Service Optimizations

1. Right-size your compute resources:
- For 25M rows, start with at least 2 CPU/8GB or 4 CPU/16GB
- You can scale up during migration if needed, then scale down after

2. Enable the appropriate addons:
- Use time-series addon if you are working with time-series data
- Use ai addon if you need vector/AI capabilities

3. Choose optimal region:
- Select the region closest to your current database to minimize network transfer time
- This significantly reduces migration duration

4. Consider enhanced storage (Enterprise only):
- If you expect high write throughput during migration, enhanced storage provides better IOPS (up to 32,000)

5. Skip replicas initially:
- Start with 0 replicas during migration
- Add replicas after migration completes to avoid duplicate data copying

6. Plan for storage space:
- Estimate your uncompressed data size
- Allocate sufficient high-performance storage (scales automatically but good to plan)
- You can enable tiered storage later for older data

During Migration Best Practices

Migration method selection:
- 25M rows: Use schema-then-data migration (migrate schema first, then copy data in chunks)
- Allows restart if a copy operation fails
- Better for databases >10GB

Database configuration to set AFTER migration:
- Set up compression policies (once data is loaded)
- Configure retention policies
- Create continuous aggregates
- Enable tiered storage for cost optimization

Connection settings:
- Use the pooled connection endpoint for better performance during bulk inserts
- Disable unnecessary constraints/indexes during migration, re-enable after

Would you like me to help you create an optimized service for this migration?
```

That beats working. Let {MCP_SHORT} do it all for you.

## Manually configure {MCP_SHORT}

Check warning on line 181 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L181

'Manually configure {MCP_SHORT}' should use sentence-style capitalization.

If your MCP client is not supported by `tiger mcp install`, follow the client's instructions to install

Check warning on line 183 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L183

Spell out 'MCP', if it's unfamiliar to the audience.

Check warning on line 183 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L183

Use 'isn't' instead of 'is not'.
MCP servers. For example, many clients use a JSON file like the following that use `tiger mcp start` to

Check warning on line 184 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L184

Spell out 'MCP', if it's unfamiliar to the audience.
start {MCP_LONG}:

```json
{
"mcpServers": {
"tiger": {
"command": "tiger",
"args": [
"mcp",
"start"
]
}
}
}
```

## {MCP_LONG} tools

Check warning on line 201 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L201

'{MCP_LONG} tools' should use sentence-style capitalization.

<MCPCOMMANDS />

## {CLI_LONG} commands for {MCP_SHORT}

Check warning on line 205 in agentic-postgres/agents/mcp-server.mdx

View check run for this annotation

Mintlify / Mintlify Validation (tigerdata-747200db) - vale-spellcheck

agentic-postgres/agents/mcp-server.mdx#L205

'{CLI_LONG} commands for {MCP_SHORT}' should use sentence-style capitalization.

<MCPCOMMANDSCLI />

## Global flags

You can use the following {CLI_LONG} global flags when you run {MCP_SHORT}:

<GLOBALFLAGS />


[rest-api-reference]: /api/api-reference
[rest-api-credentials]: https://console.cloud.timescale.com/dashboard/settings
[get-project-id]: /integrations/find-connection-details#find-your-project-and-service-id
[create-client-credentials]: /integrations/find-connection-details#create-client-credentials
[curl]: https://curl.se/
[cloud-regions]: /cloud/understand/regions
[readreplica]: /cloud/scale/ha-replicas
[manual-config]: #manually-configure-mcp-server
Loading