docs: MCP clients guides#56828
Conversation
gabrielcorado
added
no-changelog
gabrielcorado
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
|
Amplify deployment status
|
gabrielcorado
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
|
Looks good! Made some suggestions and minor fixes |
| @@ -0,0 +1,207 @@ | |||
| --- | |||
| title: MCP Access | |||
There was a problem hiding this comment.
"MCP Access" sounds nebulous; the guide discusses MCP clients, so maybe rename to something like this? Not quite sure what proper title should be.
There was a problem hiding this comment.
The idea was to assign a name to what is being accessed, as we have our MCPs (database access) and MCP servers, which Teleport serves. For the latter, I assume we're referring to it as "MCP Access".
There was a problem hiding this comment.
What do you think putting these under User Guides alongside with like database gui clients, and Teleport Connect? We can combine them into one guide too like MCP Clients.
There was a problem hiding this comment.
I'll move them, but keep the "root" link too, as per the comment on the other PR.
I don't see any problem with combining them. I want to ensure both have the same visibility, and having a larger single page (similar to the Database Access through WebUI) might not provide enough visibility for the guide that comes second. What do you think?
gabrielcorado
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
| ``` | ||
| </TabItem> | ||
|
|
||
| <TabItem label="Others"> |
There was a problem hiding this comment.
i would move this tab to be the first tab (or even before the tabs), but emphasis on tsh mcp connect <app-name> at the beginning of the section with a json example (and maybe even take an <Var name="my-mcp-server" />). and then provide the tsh mcp config example after that. tsh mcp config is a helper command after all so you don't really have to use it.
tsh mcp db config on the other hand generates resource URIs that are hard to handcraft so it's ok for the db guide to suggesting always using that.
gabrielcorado
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
|
|
||
| (!docs/pages/includes/edition-prereqs-tabs.mdx!) | ||
|
|
||
| - The Teleport MCP Access configured. See our guides for how to set up the MCP |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
i can add this link on my PR. it's like a chicken-egg that my PR needs a link from here...
Co-authored-by: Roman Tkachenko <roman@goteleport.com> Co-authored-by: STeve (Xin) Huang <xin.huang@goteleport.com>
gabrielcorado
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
gabrielcorado
had a problem deploying
to
docs-amplify
GitHub Actions
Failure
gabrielcorado
had a problem deploying
to
docs-amplify
GitHub Actions
Failure
gabrielcorado
temporarily deployed
to
docs-amplify
GitHub Actions
Inactive
|
@gabrielcorado See the table below for backport results.
|
5 participants
Related to #54705 and #56585
Adds guides on how to configure MCP clients to use the MCP server access and MCP server for Database Access.
Preview