Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -1039,6 +1039,11 @@
"source": "/admin-guides/management/export-audit-events/splunk/",
"destination": "/zero-trust-access/export-audit-events/splunk/",
"permanent": true
},
{
"source": "/model-context-preview/",
"destination": "/connect-your-client/model-context-protocol/",
"permanent": true
}
]
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
---
title: Database Access for MCP
description: How to configure MCP clients to use Teleport databases as MCP servers.
---

This guide explains how to connect to your **PostgreSQL** Teleport databases with MCP clients.

### Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- Teleport Database Service with a PostgreSQL database enrolled. See our [guides](../../enroll-resources/database-access/database-access.mdx)
for options on how to set up Database Access for PostgreSQL databases, such as
the [AWS RDS PostgreSQL](../../enroll-resources/database-access/enroll-aws-databases/rds.mdx)
and [self-hosted PostgreSQL](../../enroll-resources/database-access/enroll-self-hosted-databases/postgres-self-hosted.mdx) guides.

<Admonition type="warning" title="Security considerations">
Since language models can execute any query on your database, we advise creating
a database user with only the permissions you want the models to have. Setting
up a user with read-only permissions will help prevent accidental changes to
your database.
Comment on lines +18 to +21
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I would consider making this into a warning admonition.

Also, should we extend this section to give an example of an appropriate read-only role to create in Postgres and Teleport?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated it and added an example of a PostgreSQL script to create a read-only user. I also added references to auto-user provisioning and DAC.


Here's an example of how to create a PostgreSQL user with read-only access to
the database:

```sql
CREATE ROLE mcp_read_only WITH LOGIN;
GRANT CONNECT ON DATABASE my_database TO mcp_read_only;
GRANT USAGE ON SCHEMA public TO mcp_read_only;
GRANT SELECT ON my_table TO mcp_read_only; -- To grant read access to a single table.
GRANT SELECT ON ALL TABLES IN SCHEMA public TO mcp_read_only; -- To grant read access to all tables in the "public" schema.

GRANT rds_iam TO mcp_read_only; -- If connecting to a PostgreSQL RDS database.
```

Remember that you will also need sufficient permissions on your Teleport user to
access the database using this user.

You can also set up fine-grained permissions for use with MCP using [Auto-user
provisioning](../../enroll-resources/database-access/auto-user-provisioning/postgres.mdx)
or [Database Access Controls](../../enroll-resources/database-access/rbac.mdx).
</Admonition>

### Step 1/2. Installation

First, sign in into your Teleport cluster using `tsh login`:

```code
$ tsh login --proxy=<Var name="teleport.example.com:443" /> --user=myuser@example.com
```

Only databases that you have access to can be exposed as MCP servers. You can
retrieve the list of databases and their connection options using `tsh db ls`:

```code
$ tsh db ls
# Name Description Allowed Users Labels
# --------------- -------------------- ------------------ -------
# postgres-dev Development database [* postgres] env=dev
# postgres-prod Production database [mcp_read_only] env=prod
```

Each database you want accessible through MCP must be configured with your MCP
client individually. This is done using the `tsh mcp db config` command. Like
`tsh db connect`, this command requires you to select the database user and
database name that the MCP connections will use.

This command can either generate a configuration file (using the `mcpServers`
format) for manual MCP client updates or automatically update the MCP client
configuration.

<Tabs>
<TabItem label="Claude Desktop">
`tsh` can automatically update the Claude Desktop MCP configuration file to
include Teleport's configuration:

```code
$ tsh mcp db config --db-user=postgres --db-name=employees --client-config=claude postgres-dev
Added database "postgres-dev" on the client configuration at:
~/Library/Application Support/Claude/claude_desktop_config.json

Teleport database access MCP server is named "teleport-databases" in this configuration.

You may need to restart your client to reload these new configurations.
```

You can also provide a custom path for your Claude Desktop MCPs configuration:
```code
$ tsh mcp db config --db-user=postgres --db-name=employees --config-client=/path/to/config.json postgres-dev
```

After updating the configuration, you need to restart the Claude Desktop app
before using the newly added MCPs.
</TabItem>

<TabItem label="Cursor">
`tsh` can automatically update the Global Cursor MCP servers to include
Teleport's configuration:

```code
$ tsh mcp db config --db-user=postgres --db-name=employees --client-config=cursor postgres-dev
Added database "postgres-dev" on the client configuration at:
/your/home/path/.cursor/mcp.json

Teleport database access MCP server is named "teleport-databases" in this configuration.

You may need to restart your client to reload these new configurations.
```

You can also update a Cursor project MCP servers by providing the path to the
file:
```code
$ tsh mcp db config --db-user=postgres --db-name=employees --config-client=/path/to/project/.cursor/mcp.json postgres-dev
```
</TabItem>

<TabItem label="Others">
Currently, `tsh` only supports generating the `mcpServers` format and some
client-specific formats. Running the config command without any specific options
will output the configuration used to start Teleport's STDIO MCP server. You can
use this as a base and modify it to suit your MCP client needs.

```code
$ tsh mcp db config --db-user=postgres --db-name=employees postgres-dev
Here is a sample JSON configuration for launching Teleport MCP servers:
{
"mcpServers": {
"teleport-databases": {
"command": "tsh",
"args": [
"mcp",
"db",
"start",
"teleport://clusters/teleport.example.com/databases/postgres-dev?dbName=employees&dbUser=postgres"
]
}
}
}

If you already have an entry for "teleport-databases" server, add the following database resource URI to the command arguments list:
teleport://clusters/teleport.example.com/databases/postgres-dev?dbName=employees&dbUser=postgres
```
</TabItem>
</Tabs>

### Step 2/2. Usage

After configuring your MCP client, the following tools will be available:

- `teleport_list_databases`: Lists database resources accessible with Teleport tools.
- `teleport_postgres_query` (PostgreSQL databases only): Executes SQL queries on a specified database through Teleport.

Additionally, the served databases are available as MCP resources. You can
attach them to the conversation to provide extra context. Behavior may vary
among MCP clients.

You can now use these tools to execute queries on your databases. Here is an
example of testing the connection and retrieving the database version using
Claude Desktop:

![Database access usage example](../../../img/connect-your-client/model-context-protocol/usage-example-database-access.png)

### Troubleshooting

#### Empty list of databases or missing `teleport_postgres_query` tool

This occurs if the MCP server command (`tsh mcp db start`) has an invalid list
of databases or options. Make sure the database URI list is correct. You can
generate it using the `tsh mcp db config` command.

In this case, you'll still be able to see and call `teleport_list_databases`,
which will provide instructions on how to proceed.

#### Expired `tsh` session

There must be a valid `tsh` session during the MCP server startup, or it won't
start.

If your session expires while the MCP server is running, the next tool calls
will fail. You need to run `tsh login` again and retry the failed requests. In
such cases, you don't have to restart the MCP client or the MCP server.

#### Access denied errors

If, while executing queries, you receive access denied responses, verify that
your user has permission to access the configured database. You can confirm by
running `tsh db connect` before starting your MCP server.

For example, if you configured your database with:

```code
$ tsh mcp db config --db-user=postgres --db-name=employees postgres-dev
```

You must be able to test your access by running:

```code
$ tsh db connect --db-user=postgres --db-name=employees postgres-dev
```
159 changes: 159 additions & 0 deletions docs/pages/connect-your-client/model-context-protocol/mcp-access.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
---
title: MCP Access
description: How to configure MCP clients to use MCP servers served by Teleport.
---

This guide explains how to configure MCP clients to access MCP servers served by
Teleport.

### Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)

- The Teleport MCP Access configured. See our guides for how to set up the MCP
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'd make this more specific than "see our guides". I'd say "Follow the [xxx] guide to connect MCP server to Teleport" with a link to the guide.

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 can add this link on my PR. it's like a chicken-egg that my PR needs a link from here...

Access.

### Step 1/2. Installation

First, sign in into your Teleport cluster using `tsh login`:

```code
$ tsh login --proxy=<Var name="teleport.example.com:443" /> --user=myuser@example.com
```

You can now list the available MCP servers that you can use:

```code
$ tsh mcp ls
Name Description Type Labels
-------------- ------------------------------------------ ----- --------------------
fs Filesystem MCP Server stdio env=prod
mcp-everything This MCP server attempts to exercise al... stdio env=dev,sandbox=true
```

The MCP client configuration can be created using the `tsh mcp config` command.
You can choose which servers to configure by using the `--labels` flag to filter
by labels or by specifying `--all`, which will configure all MCP servers you have
access to.

This command can either generate a configuration file (using the `mcpServers`
format) for manual MCP client updates or automatically update the MCP client
configuration.

<Tabs>
<TabItem label="Claude Desktop">
`tsh` can automatically update the Claude Desktop MCP configuration file to
include Teleport's configuration:

```code
$ tsh mcp config --all --config-client=claude
Found MCP servers:
fs
mcp-everything

Updated client configuration at:
~/Library/Application Support/Claude/claude_desktop_config.json

Teleport MCP servers will be prefixed with "teleport-mcp-" in this
configuration.

You may need to restart your client to reload these new configurations. If you
encounter a "disconnected" error when tsh session expires, you may also need to
restart your client after logging in a new tsh session.
```

You can also provide a custom path for your Claude Desktop MCPs configuration:
```code
$ tsh mcp config --all --config-client=/path/to/config.json
```

After updating the configuration, you need to restart the Claude Desktop app
before using the newly added MCPs.
</TabItem>

<TabItem label="Cursor">
`tsh` can automatically update the Global Cursor MCP servers to include
Teleport's configuration:

```code
$ tsh mcp config --all --config-client=cursor
Found MCP servers:
fs
mcp-everything

Updated client configuration at:
/your/home/path/.cursor/mcp.json

Teleport MCP servers will be prefixed with "teleport-mcp-" in this
configuration.

You may need to restart your client to reload these new configurations. If you
encounter a "disconnected" error when tsh session expires, you may also need to
restart your client after logging in a new tsh session.
```

You can also update a Cursor project MCP servers by providing the path to the
file:
```code
$ tsh mcp config --all --config-client=/path/to/project/.cursor/mcp.json
```
</TabItem>

<TabItem label="Others">
Currently, `tsh` only supports generating the `mcpServers` format and some
client-specific formats. Running the config command without any specific options
will output configuration used to start Teleport's STDIO MCP server. You can use
this as a base and modify it to suit your MCP client needs.

```code
$ tsh mcp config --all
Found MCP servers:
fs
mcp-everything

Here is a sample JSON configuration for launching Teleport MCP servers:
{
"mcpServers": {
"teleport-mcp-fs": {
"command": "tsh",
"args": ["mcp", "connect", "fs"]
},
"teleport-mcp-mcp-everything": {
"command": "tsh",
"args": ["mcp", "connect", "mcp-everything"]
}
}
}
```
</TabItem>
</Tabs>

### Step 2/2. Usage

After configuring your MCP client, the MCP tools and resources should be
available.

You can now use the MCP servers as usual. Here is an example of using the
`mcp-everything` server through Teleport with Claude Desktop:

![MCP everything usage example](../../../img/connect-your-client/model-context-protocol/usage-example-everything.png)

### Troubleshooting

#### Server is running but it has an empty list of tools

Besides accessing the MCP servers, you also need permissions for the MCP tools
they provide. You can see which tools are available for you by running
`tsh mcp ls -v`.

If you're missing tool permissions, reach out to your Teleport administrator to
have them properly configured.

#### Expired `tsh` session

There must be a valid `tsh` session during the MCP server startup, or it won't
start.

If your session expires while the MCP server is running, the next tool calls
will fail. You need to run `tsh login` again and retry the failed requests. In
such cases, you don't have to restart the MCP client or the MCP server.
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,4 @@ Secure Large Language Model (LLM) interactions with infrastructure using Telepor
[Model Context Protocol](https://goteleport.com/use-cases/secure-model-context-protocol/) (MCP),
delivering fine-grained access control and audit between LLMs and data sources or MCP servers.

<Admonition type="tip">

MCP support is coming soon.

Want to be notified when it's available? Sign up for [Early Access](https://goteleport.com/mcp-early-access/)!

</Admonition>
<DocCardList />
Loading
Loading