Repository navigation
[DCV-3510][DCV-4024] Document MCP servers and AI tools #33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
jesusmgg
wants to merge
8
commits into
main
Choose a base branch
from
DCV-3510-add-prometheus-loki-github-and-airflow-mcp-servers-to-roo
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+414
−2
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b529000
Update docs for VSCode MCP and AI tools
jesusmgg cd8979e
Improve SEO metadata for new MCP and AI tools docs
fmercadop 47367e9
[DCV-3510] Document the Snowflake MCP server
jesusmgg db36d94
[DCV-3510] Scope the Snowflake MCP delivery claim to the standard env…
jesusmgg da90272
[DCV-3510] Merge origin/main into DCV-3510-add-prometheus-loki-github…
jesusmgg 86c72f0
[DCV-3510] Document the Snowflake managed MCP server toggle and its d…
jesusmgg a0f4e64
[DCV-3510] Snowflake MCP page: lone-server fallback, full delivery li…
jesusmgg 74f5400
[DCV-3510] Snowflake MCP pages: server served from the workspace, Cla…
jesusmgg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| title: GitHub Copilot | ||
| description: Enable and log in to GitHub Copilot in your Datacoves VS Code workspace, and use it with the Datacoves MCP servers. | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # GitHub Copilot | ||
|
|
||
| [GitHub Copilot](https://github.com/features/copilot) is built into the Datacoves VS Code | ||
| workspace as the GitHub Copilot and Copilot Chat extensions. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A GitHub account with an active GitHub Copilot subscription. | ||
| - GitHub Copilot enabled in your Datacoves environment. An administrator enables it under | ||
| **Admin > Environments > _your environment_ > AI Tools > AI Extensions**. | ||
|
|
||
| ## Login | ||
|
|
||
| 1. Open your Datacoves VS Code workspace. | ||
| 2. Open the Copilot Chat view, or click the Copilot icon in the status bar. | ||
| 3. Choose to sign in and follow the GitHub authentication prompt in your browser. | ||
| 4. Once authorized, Copilot is ready in both inline suggestions and chat. | ||
|
|
||
| ## MCP servers | ||
|
|
||
| GitHub Copilot can use the Datacoves [MCP servers](/docs/how-tos/vs-code/mcp) (GitHub, Airflow, | ||
| Grafana, Snowflake) when they are enabled for your environment. The GitHub Copilot CLI gets the | ||
| [Snowflake server](/docs/how-tos/vs-code/mcp/snowflake) too. | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [GitHub Copilot documentation](https://docs.github.com/en/copilot) |
34 changes: 34 additions & 0 deletions
34
docs/how-tos/vs-code/external-ai-tools/snowflake-cortex.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| title: Snowflake Cortex | ||
| description: Enable and use Snowflake Cortex, Snowflake's AI coding assistant CLI, in your Datacoves VS Code workspace. | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # Snowflake Cortex | ||
|
|
||
| [Snowflake Cortex Code](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code-cli) is | ||
| Snowflake's AI coding assistant, available as a CLI tool in Datacoves. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A Snowflake-based (`dbt-snowflake`) environment. Cortex is only available on Snowflake | ||
| environments. | ||
| - Cortex enabled in your Datacoves environment. Contact | ||
| [Datacoves support](mailto:support@datacoves.com) to enable it, or an administrator can turn it | ||
| on under **Admin > Environments > _your environment_ > AI Tools**. | ||
|
|
||
| ## Login and usage | ||
|
|
||
| Cortex authenticates against Snowflake and is driven from a terminal in your Datacoves VS Code | ||
| workspace. See | ||
| [Snowflake's Cortex Code CLI documentation](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code-cli) | ||
| for the authentication and usage steps. | ||
|
|
||
| ## MCP servers | ||
|
|
||
| Cortex can use the Datacoves [MCP servers](/docs/how-tos/vs-code/mcp) (GitHub, Airflow, Grafana, | ||
| Snowflake) when they are enabled for your environment. | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Snowflake Cortex Code documentation](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code-cli) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| title: MCP Servers | ||
| description: Connect GitHub, Airflow, Grafana, and Snowflake MCP servers to give AI tools in your Datacoves VS Code workspace read access to real repositories, DAGs, metrics, logs, and data. | ||
| sidebar_position: 46 | ||
| --- | ||
|
|
||
| # MCP Servers | ||
|
|
||
| Datacoves can connect your AI coding assistants to live data systems through | ||
| [MCP (Model Context Protocol)](https://modelcontextprotocol.io/) servers. An MCP server gives an | ||
| AI tool structured, read access to an external system so it can answer questions grounded in your | ||
| real data instead of guessing. | ||
|
|
||
| Datacoves ships four MCP servers: | ||
|
|
||
| | Server | What it exposes | User setup | | ||
| |--------|-----------------|------------| | ||
| | [GitHub](/docs/how-tos/vs-code/mcp/github) | Your repositories, pull requests, issues, and CI checks | A GitHub personal access token | | ||
| | [Airflow](/docs/how-tos/vs-code/mcp/airflow) | Your DAGs, runs, and task logs (read-only) | None | | ||
| | [Grafana (Prometheus & Loki)](/docs/how-tos/vs-code/mcp/grafana) | Metrics and logs from your environment | None | | ||
| | [Snowflake](/docs/how-tos/vs-code/mcp/snowflake) | Your Snowflake data and metadata, through read-only SQL | An MCP server created in your Snowflake account | | ||
|
|
||
| Once enabled, the GitHub, Airflow, Grafana, and Snowflake servers are available to every AI tool in | ||
| your workspace: | ||
|
|
||
| - Datacoves Copilot | ||
| - GitHub Copilot | ||
| - [OpenAI Codex](/docs/how-tos/vs-code/external-ai-tools/openai-codex) | ||
| - [Snowflake Cortex](/docs/how-tos/vs-code/external-ai-tools/snowflake-cortex) | ||
|
|
||
| The Snowflake server also reaches [Claude Code](/docs/how-tos/vs-code/external-ai-tools/claude-code), | ||
| the extension and the CLI, and the GitHub Copilot CLI. | ||
|
|
||
| ## Enabling MCP servers | ||
|
|
||
| MCP servers are toggled per environment by an administrator. | ||
|
|
||
| :::note | ||
| You need admin access to enable MCP servers. Go to **Admin > Environments**, edit the | ||
| environment, open the **AI Tools** tab, and turn on the servers you want under **MCP Servers**. | ||
| ::: | ||
|
|
||
|  | ||
|
|
||
| After a server is enabled, it appears automatically in each AI tool the next time the workspace | ||
| starts. No further configuration is needed in the tools themselves. | ||
|
|
||
| :::tip | ||
| The **Grafana (Prometheus & Loki)** toggle only appears when the **observability stack** is | ||
| enabled for your cluster. Contact [Datacoves support](mailto:support@datacoves.com) if you do not | ||
| see it. | ||
| ::: | ||
|
|
||
| ## What you can ask | ||
|
|
||
| Each server page includes example prompts. A few to get started: | ||
|
|
||
| - **GitHub:** "Check my last pull request and explain why the CI check failed." | ||
| - **Airflow:** "Check the log of the task that failed in my last DAG run and recommend a fix." | ||
| - **Grafana:** "Query the metrics and logs for my environment and summarize recent failures." | ||
| - **Snowflake:** "Which columns does the customers table have, and how many rows are in it?" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| title: Airflow MCP Server | ||
| sidebar_label: Airflow | ||
| description: Connect the Airflow MCP server so AI tools in VS Code can read your DAGs, runs, and task logs to investigate failures and recommend fixes. | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # Airflow MCP Server | ||
|
|
||
| The Airflow MCP server lets your AI tools read your DAGs, runs, and task logs, so you can ask the | ||
| AI to investigate a failed task and recommend a fix without leaving VS Code. | ||
|
|
||
| It is backed by [Astronomer's Airflow MCP server](https://github.com/astronomer/agents/tree/main/astro-airflow-mcp) | ||
| and works with both Airflow 2 and Airflow 3. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - The **Airflow** MCP server enabled for your environment (see [Enabling](#enabling)). | ||
| - Airflow enabled and running for your environment. | ||
|
|
||
| ## How it works | ||
|
|
||
| - **No setup required.** The server authenticates as **you**, using your Datacoves identity, so it | ||
| only sees what your Airflow permissions allow. | ||
| - **Read-only by default.** The server is configured for read access, so the AI can inspect DAGs, | ||
| runs, and logs but cannot trigger, pause, or change anything. | ||
| - Works with both your team's Airflow and, when enabled, your personal **My Airflow** instance. | ||
|
|
||
| ## Enabling | ||
|
|
||
| :::note | ||
| An administrator enables the server in **Admin > Environments > _your environment_ > AI Tools > | ||
| MCP Servers** by turning on **Airflow**. | ||
| ::: | ||
|
|
||
| ## Use it | ||
|
|
||
| Start (or restart) your workspace so the AI tools pick up the server, then ask, for example: | ||
|
|
||
| > Check the log of the task that failed in my last DAG run and recommend a fix. | ||
|
|
||
| > Which DAGs failed today, and what was the error? | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Astronomer Airflow MCP server](https://github.com/astronomer/agents/tree/main/astro-airflow-mcp) |
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| title: GitHub MCP Server | ||
| sidebar_label: GitHub | ||
| description: Connect the GitHub MCP server so AI tools in VS Code can read your repositories, pull requests, issues, and CI checks using a personal access token. | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| # GitHub MCP Server | ||
|
|
||
| The GitHub MCP server lets your AI tools read your GitHub repositories, pull requests, issues, and | ||
| CI checks, so you can ask questions like why a check failed and get an answer based on the real | ||
| pull request. | ||
|
|
||
| It is backed by [GitHub's official MCP server](https://github.com/github/github-mcp-server). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - The **GitHub** MCP server enabled for your environment (see [Enabling](#enabling)). | ||
| - A GitHub [personal access token](https://github.com/settings/tokens) with access to the | ||
| repositories you want the AI to read. | ||
|
|
||
| ## Provide your GitHub token | ||
|
|
||
| The GitHub MCP server acts as **you**, using your own personal access token. You provide it as a | ||
| VS Code environment variable, so it is never shared with other users. | ||
|
|
||
| ### Step 1: Create a personal access token | ||
|
|
||
| In GitHub, create a [personal access token](https://github.com/settings/tokens) (classic or | ||
| fine-grained) with at least `repo` scope. Copy the token, you will not be able to see it again. | ||
|
|
||
| ### Step 2: Add it as an environment variable | ||
|
|
||
| Add the token as a [user-level VS Code environment variable](/docs/how-tos/vs-code/environment-variables) | ||
| named: | ||
|
|
||
| ``` | ||
| GITHUB_PERSONAL_ACCESS_TOKEN | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| :::tip | ||
| The value is automatically masked in the UI because the variable name contains `token`. | ||
| ::: | ||
|
|
||
| ## Enabling | ||
|
|
||
| :::note | ||
| An administrator enables the server in **Admin > Environments > _your environment_ > AI Tools > | ||
| MCP Servers** by turning on **GitHub**. | ||
| ::: | ||
|
|
||
| ## Use it | ||
|
|
||
| Start (or restart) your workspace so the AI tools pick up the server, then ask, for example: | ||
|
|
||
| > Check my last pull request, figure out why the CI check failed, and recommend a fix. | ||
|
|
||
| > List my open pull requests in this repository. | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [GitHub MCP server](https://github.com/github/github-mcp-server) | ||
| - [Managing personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| --- | ||
| title: Grafana MCP Server (Prometheus & Loki) | ||
| sidebar_label: Grafana (Prometheus & Loki) | ||
| description: Connect the Grafana MCP server so AI tools in VS Code can query Prometheus metrics and Loki logs for your Datacoves environment. | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Grafana MCP Server | ||
|
|
||
| The Grafana MCP server lets your AI tools query the metrics (Prometheus) and logs (Loki) for your | ||
| environment, so you can ask the AI to summarize recent failures or look up a specific log. | ||
|
|
||
| It is backed by [Grafana's MCP server](https://github.com/grafana/mcp-grafana). | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - The **observability stack** enabled for your cluster. The Grafana MCP toggle only appears when | ||
| it is. Contact [Datacoves support](mailto:support@datacoves.com) if you need it enabled. | ||
| - The **Grafana (Prometheus & Loki)** MCP server enabled for your environment (see | ||
| [Enabling](#enabling)). | ||
|
|
||
| ## How it works | ||
|
|
||
| **No setup required.** Datacoves provisions a per-environment service account for the server, so | ||
| there is nothing for you to configure. The server connects to your environment's Grafana, which | ||
| already has the Prometheus and Loki data sources wired up. | ||
|
|
||
| ## Enabling | ||
|
|
||
| :::note | ||
| An administrator enables the server in **Admin > Environments > _your environment_ > AI Tools > | ||
| MCP Servers** by turning on **Grafana (Prometheus & Loki)**. | ||
| ::: | ||
|
|
||
| ## Use it | ||
|
|
||
| Start (or restart) your workspace so the AI tools pick up the server, then ask, for example: | ||
|
|
||
| > Query the metrics and logs for my environment and summarize recent failures. | ||
|
|
||
| > Show me the Loki logs for my Airflow workers in the last hour. | ||
|
|
||
| ## Learn more | ||
|
|
||
| - [Grafana MCP server](https://github.com/grafana/mcp-grafana) | ||
| - [Grafana dashboards in Datacoves](/docs/how-tos/datacoves/metrics-and-logs/grafana) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jesusmgg why does this PR have stuff about secrets manager?
@gams87 Does this change with the secrets manager change you were working on? i think in 6.1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, it doesn't change anything. This PR only fixes two broken links in that page's table of contents (they broke when I renamed those sections in #58). The guide itself isn't touched, so it's fine to merge. Any doc updates for the 6.1 secrets manager change will go with that work.