Add Documentation MCP server pages to chronograf, kapacitor, flux, and explorer (#6833)
* Initial plan * feat: add Documentation MCP server pages to chronograf, kapacitor, flux, and explorer Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * fix: update MCP page descriptions to include product names Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * fix: resolve product-name shortcode for v1/v0 versioned products The shortcode previously only checked the second URL path segment to identify products, which works for InfluxDB 3 (/influxdb3/core/) but fails for older products where the second segment is a version number (/chronograf/v1/, /flux/v0/). Add namespace extraction (first path segment) and conditional logic to look up products by namespace when the version is v1 or v0. This fixes empty product names in meta descriptions for Chronograf, Telegraf, Kapacitor, Flux, and InfluxDB Enterprise v1. * feat: relocate v2/cloud MCP pages and add alt_links for cross-product navigation - Move MCP server pages from reference/ to tools/ for InfluxDB v2 and Cloud - Add alt_links frontmatter to all MCP pages for cross-product navigation - Use product-name shortcode in descriptions for consistency - Convert code-placeholders shortcode to fenced code block attributes - Update shared content to use version-agnostic URLs * Add multi-assistant installation instructions for documentation MCP server (#6836) * Initial plan * feat(mcp): add installation instructions for multiple AI assistants Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> * refactor(mcp): replace Cline and Windsurf with GitHub Copilot and OpenCode Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>release/3.8.1
Copilot
GitHub
parent
b4a0eea0a3
commit
ba28e124b1
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
chronograf_v1:
|
||||
name: Documentation MCP server
|
||||
parent: Tools
|
||||
weight: 204
|
||||
tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
enterprise_influxdb_v1:
|
||||
|
|
@ -9,6 +9,11 @@ menu:
|
|||
parent: Tools
|
||||
weight: 100
|
||||
enterprise_influxdb/v1/tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
flux_v0_ref:
|
||||
name: Documentation MCP server
|
||||
weight: 206
|
||||
tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb_cloud:
|
||||
name: Documentation MCP server
|
||||
parent: Reference
|
||||
weight: 206
|
||||
influxdb/cloud/tags: [MCP, LLM, AI]
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb_cloud:
|
||||
name: Documentation MCP server
|
||||
parent: Tools & integrations
|
||||
weight: 206
|
||||
influxdb/cloud/tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb_v1:
|
||||
|
|
@ -9,6 +9,11 @@ menu:
|
|||
parent: Tools
|
||||
weight: 100
|
||||
influxdb/v1/tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb_v2:
|
||||
name: Documentation MCP server
|
||||
parent: Reference
|
||||
weight: 206
|
||||
influxdb/v2/tags: [MCP, LLM, AI]
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb_v2:
|
||||
name: Documentation MCP server
|
||||
parent: Tools & integrations
|
||||
weight: 206
|
||||
influxdb/v2/tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -3,7 +3,8 @@ title: Use the InfluxDB 3 MCP server
|
|||
description: >
|
||||
Use the **InfluxDB MCP server** to interact with and manage {{% product-name %}}
|
||||
using natural language with LLM agents to query and analyze data, manage databases
|
||||
and more.
|
||||
and more. Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb3_cloud_dedicated:
|
||||
name: Use the InfluxDB MCP server
|
||||
|
|
@ -12,6 +13,11 @@ weight: 110
|
|||
influxdb3/cloud-dedicated/tags: [MCP, LLM, AI]
|
||||
related:
|
||||
- https://github.com/influxdata/influxdb3_mcp_server, InfluxDB 3 MCP Server GitHub Repository
|
||||
alt_links:
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
clustered: /influxdb3/clustered/reference/mcp-server/
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb3_cloud_serverless:
|
||||
|
|
@ -9,6 +9,11 @@ menu:
|
|||
parent: Reference
|
||||
weight: 206
|
||||
influxdb3/cloud-serverless/tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
clustered: /influxdb3/clustered/reference/mcp-server/
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb3_clustered:
|
||||
|
|
@ -9,6 +9,11 @@ menu:
|
|||
parent: Reference
|
||||
weight: 206
|
||||
influxdb3/clustered/tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@ title: Use the InfluxDB 3 MCP server
|
|||
description: >
|
||||
Use the **InfluxDB MCP server** to interact with and manage {{% product-name %}}
|
||||
using natural language with LLM agents to query and analyze data, manage databases
|
||||
and more.
|
||||
and more. Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb3_core:
|
||||
name: Use the InfluxDB MCP server
|
||||
|
|
@ -12,6 +13,11 @@ weight: 206
|
|||
influxdb3/core/tags: [MCP, LLM, AI]
|
||||
related:
|
||||
- https://github.com/influxdata/influxdb3_mcp_server, InfluxDB 3 MCP Server GitHub Repository
|
||||
alt_links:
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
clustered: /influxdb3/clustered/reference/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@ title: Use the InfluxDB 3 MCP server
|
|||
description: >
|
||||
Use the **InfluxDB MCP server** to interact with and manage {{% product-name %}}
|
||||
using natural language with LLM agents to query and analyze data, manage databases
|
||||
and more.
|
||||
and more. Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb3_enterprise:
|
||||
name: Use the InfluxDB MCP server
|
||||
|
|
@ -12,6 +13,11 @@ weight: 206
|
|||
influxdb3/enterprise/tags: [MCP, LLM, AI]
|
||||
related:
|
||||
- https://github.com/influxdata/influxdb3_mcp_server, InfluxDB 3 MCP Server GitHub Repository
|
||||
alt_links:
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
clustered: /influxdb3/clustered/reference/mcp-server/
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
influxdb3_explorer:
|
||||
name: Documentation MCP server
|
||||
weight: 206
|
||||
tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
clustered: /influxdb3/clustered/reference/mcp-server/
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
kapacitor_v1_ref:
|
||||
name: Documentation MCP server
|
||||
weight: 206
|
||||
tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
<!-- //SOURCE content/shared/influxdb3-admin/mcp-server-docs-only.md -->
|
||||
|
|
@ -19,7 +19,7 @@ in your IDE and get responses grounded in official documentation.
|
|||
## Install the documentation MCP server
|
||||
|
||||
The documentation MCP server is a hosted service—you don't need to install or run anything locally.
|
||||
Add the server URL to your AI tool's MCP configuration.
|
||||
Add the server URL to your AI assistant's MCP configuration.
|
||||
|
||||
> [!Note]
|
||||
> On first use, you'll be prompted to sign in with Google.
|
||||
|
|
@ -32,7 +32,139 @@ https://influxdb-docs.mcp.kapa.ai
|
|||
```
|
||||
|
||||
The server uses SSE (Server-Sent Events) transport.
|
||||
For help adding MCP servers, refer to your tool's documentation or ask your AI assistant.
|
||||
|
||||
### Configure your AI assistant to use the documentation MCP server
|
||||
|
||||
The following instructions show how to configure popular AI assistants to use the InfluxDB documentation MCP server.
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[Claude Desktop](#)
|
||||
[ChatGPT Desktop](#)
|
||||
[GitHub Copilot (VS Code)](#)
|
||||
[Cursor](#)
|
||||
[OpenCode](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN CLAUDE DESKTOP ---------------------------->
|
||||
|
||||
In **Claude Desktop**, go to **Settings** > **Developer** and edit your configuration.
|
||||
Add the following JSON configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb-docs": {
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Save the file and restart Claude Desktop for the changes to take effect.
|
||||
|
||||
<!----------------------------- END CLAUDE DESKTOP ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN CHATGPT DESKTOP ---------------------------->
|
||||
|
||||
In **ChatGPT Desktop**, go to **Settings** > **Integrations** > **Enable MCP** and add a new server.
|
||||
Add the following JSON configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb-docs": {
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai",
|
||||
"transport": "sse"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Save the configuration and restart ChatGPT Desktop.
|
||||
|
||||
<!----------------------------- END CHATGPT DESKTOP ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN GITHUB COPILOT ---------------------------->
|
||||
|
||||
In **VS Code**, configure GitHub Copilot to use the MCP server:
|
||||
|
||||
1. Create or edit `.vscode/mcp.json` in your workspace or project directory
|
||||
2. Add the following configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"servers": {
|
||||
"influxdb-docs": {
|
||||
"type": "http",
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Restart or reload VS Code
|
||||
4. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
|
||||
5. Run **MCP: List Servers** to verify the server is registered
|
||||
|
||||
The InfluxDB documentation MCP server will now be available through GitHub Copilot Chat.
|
||||
|
||||
<!----------------------------- END GITHUB COPILOT ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN CURSOR ---------------------------->
|
||||
|
||||
In **Cursor**, add the MCP server configuration to your MCP settings file.
|
||||
|
||||
1. Open **Settings** and navigate to **MCP Servers**
|
||||
2. Click **Add MCP Server** or edit the configuration file directly
|
||||
3. Add the following configuration to `.cursor/mcp.json` (project-level) or `~/.cursor/mcp.json` (global):
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb-docs": {
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai",
|
||||
"transport": "streamableHttp"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Save the file and restart Cursor.
|
||||
|
||||
<!----------------------------- END CURSOR ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN OPENCODE ---------------------------->
|
||||
|
||||
In **OpenCode**, configure the MCP server in your configuration file:
|
||||
|
||||
1. Create or edit `opencode.json` (or `opencode.jsonc`) in your workspace
|
||||
2. Add the following configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"influxdb-docs": {
|
||||
"type": "remote",
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Start OpenCode and use the `/init` command to verify the MCP server is accessible
|
||||
|
||||
The InfluxDB documentation search tools will be available in your OpenCode sessions.
|
||||
|
||||
<!----------------------------- END OPENCODE ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
## Authentication and rate limits
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
InfluxDB provides two Model Context Protocol (MCP) servers for integrating with AI assistants:
|
||||
|
||||
- [Manage your InfluxDB instance with the database MCP server](#manage-your-influxdb-instance-with-the-database-mcp-server)
|
||||
- [Query InfluxDB documentation from your IDE](#query-influxdb-documentation-from-your-ide)
|
||||
- [Query documentation from your IDE](#query-documentation-from-your-ide)
|
||||
|
||||
## Manage your InfluxDB instance with the database MCP server
|
||||
|
||||
|
|
@ -129,8 +129,7 @@ In **Claude Desktop**, go to **Settings** > **Developer** and edit your configur
|
|||
Enter the following JSON configuration:
|
||||
|
||||
{{% show-in "core,enterprise" %}}
|
||||
{{% code-placeholders "path/to|AUTH_TOKEN" %}}
|
||||
```json
|
||||
```json { placeholders="path/to|AUTH_TOKEN" }
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb": {
|
||||
|
|
@ -145,7 +144,6 @@ Enter the following JSON configuration:
|
|||
}
|
||||
}
|
||||
```
|
||||
{{% /code-placeholders %}}
|
||||
|
||||
Replace the following:
|
||||
|
||||
|
|
@ -159,8 +157,7 @@ Replace the following:
|
|||
|
||||
{{% show-in "cloud-dedicated" %}}
|
||||
|
||||
{{% code-placeholders "path/to|DEDICATED_(CLUSTER|ACCOUNT|DATABASE|MANAGEMENT)_(ID|TOKEN)" %}}
|
||||
```json
|
||||
```json { placeholders="path/to|DEDICATED_ACCOUNT_ID|DEDICATED_CLUSTER_ID|DEDICATED_DATABASE_TOKEN|DEDICATED_MANAGEMENT_TOKEN" }
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb": {
|
||||
|
|
@ -177,7 +174,6 @@ Replace the following:
|
|||
}
|
||||
}
|
||||
```
|
||||
{{% /code-placeholders %}}
|
||||
|
||||
Replace the following:
|
||||
|
||||
|
|
@ -188,11 +184,11 @@ Replace the following:
|
|||
- {{% code-placeholder-key %}}`DEDICATED_CLUSTER_ID`{{% /code-placeholder-key %}}:
|
||||
Your {{% product-name omit=" Clustered" %}} cluster ID
|
||||
- {{% code-placeholder-key %}}`DEDICATED_DATABASE_TOKEN`{{% /code-placeholder-key %}}:
|
||||
A [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) with
|
||||
A [database token](/influxdb3/version/admin/tokens/database/) with
|
||||
permissions that grant access to all databases you would like your LLM agent
|
||||
to be able to write data to and query data from
|
||||
- {{% code-placeholder-key %}}`DEDICATED_MANAGEMENT_TOKEN`{{% /code-placeholder-key %}}:
|
||||
A [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) that
|
||||
A [management token](/influxdb3/version/admin/tokens/management/) that
|
||||
lets your LLM agent perform administrative tasks on your {{% product-name %}} cluster
|
||||
|
||||
{{% /show-in %}}
|
||||
|
|
@ -223,8 +219,7 @@ In the examples below, replace the following:
|
|||
|
||||
##### Connect to a remote InfluxDB server
|
||||
|
||||
{{% code-placeholders "path/to|AUTH_TOKEN" %}}
|
||||
```json
|
||||
```json { placeholders="path/to|AUTH_TOKEN" }
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb": {
|
||||
|
|
@ -250,12 +245,10 @@ In the examples below, replace the following:
|
|||
}
|
||||
}
|
||||
```
|
||||
{{% /code-placeholders %}}
|
||||
|
||||
##### Connect to a local InfluxDB server
|
||||
|
||||
{{% code-placeholders "path/to|AUTH_TOKEN" %}}
|
||||
```json
|
||||
```json { placeholders="AUTH_TOKEN" }
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb": {
|
||||
|
|
@ -282,14 +275,11 @@ In the examples below, replace the following:
|
|||
}
|
||||
}
|
||||
```
|
||||
{{% /code-placeholders %}}
|
||||
|
||||
{{% /show-in %}}
|
||||
|
||||
{{% show-in "cloud-dedicated" %}}
|
||||
|
||||
{{% code-placeholders "path/to|DEDICATED_(CLUSTER|ACCOUNT|DATABASE|MANAGEMENT)_(ID|TOKEN)" %}}
|
||||
```json
|
||||
```json { placeholders="DEDICATED_ACCOUNT_ID|DEDICATED_CLUSTER_ID|DEDICATED_DATABASE_TOKEN|DEDICATED_MANAGEMENT_TOKEN" }
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb": {
|
||||
|
|
@ -321,7 +311,6 @@ In the examples below, replace the following:
|
|||
}
|
||||
}
|
||||
```
|
||||
{{% /code-placeholders %}}
|
||||
|
||||
Replace the following:
|
||||
|
||||
|
|
@ -367,16 +356,16 @@ including:
|
|||
>
|
||||
> "Show me the schema for the `sensor_data` table."
|
||||
|
||||
## Query InfluxDB documentation from your IDE
|
||||
## Query documentation from your IDE
|
||||
|
||||
The **InfluxDB documentation MCP server** lets AI tools and agents search InfluxDB
|
||||
documentation directly from your development environment.
|
||||
{{% product-name %}} documentation directly from your development environment.
|
||||
Use it to find answers, code examples, and configuration details without leaving your IDE.
|
||||
|
||||
### Why use the documentation MCP server?
|
||||
|
||||
When you connect the documentation MCP server to your AI coding assistant, the assistant
|
||||
can search InfluxDB documentation to answer your questions with accurate, up-to-date information.
|
||||
can search InfluxDB and related tool documentation to answer your questions with accurate, up-to-date information.
|
||||
Instead of switching to a browser or guessing at syntax, you can ask questions
|
||||
in your IDE and get responses grounded in official documentation.
|
||||
|
||||
|
|
@ -390,7 +379,7 @@ in your IDE and get responses grounded in official documentation.
|
|||
### Install the documentation MCP server
|
||||
|
||||
The documentation MCP server is a hosted service—you don't need to install or run anything locally.
|
||||
Add the server URL to your AI tool's MCP configuration.
|
||||
Add the server URL to your AI assistant's MCP configuration.
|
||||
|
||||
> [!Note]
|
||||
> On first use, you'll be prompted to sign in with Google.
|
||||
|
|
@ -403,7 +392,139 @@ https://influxdb-docs.mcp.kapa.ai
|
|||
```
|
||||
|
||||
The server uses SSE (Server-Sent Events) transport.
|
||||
For help adding MCP servers, refer to your tool's documentation or ask your AI assistant.
|
||||
|
||||
#### Configure your AI assistant to use the documentation MCP server
|
||||
|
||||
The following instructions show how to configure popular AI assistants to use the InfluxDB documentation MCP server.
|
||||
|
||||
{{< tabs-wrapper >}}
|
||||
{{% tabs %}}
|
||||
[Claude Desktop](#)
|
||||
[ChatGPT Desktop](#)
|
||||
[GitHub Copilot (VS Code)](#)
|
||||
[Cursor](#)
|
||||
[OpenCode](#)
|
||||
{{% /tabs %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN CLAUDE DESKTOP ---------------------------->
|
||||
|
||||
In **Claude Desktop**, go to **Settings** > **Developer** and edit your configuration.
|
||||
Add the following JSON configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb-docs": {
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Save the file and restart Claude Desktop for the changes to take effect.
|
||||
|
||||
<!----------------------------- END CLAUDE DESKTOP ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN CHATGPT DESKTOP ---------------------------->
|
||||
|
||||
In **ChatGPT Desktop**, go to **Settings** > **Integrations** > **Enable MCP** and add a new server.
|
||||
Add the following JSON configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb-docs": {
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai",
|
||||
"transport": "sse"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Save the configuration and restart ChatGPT Desktop.
|
||||
|
||||
<!----------------------------- END CHATGPT DESKTOP ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN GITHUB COPILOT ---------------------------->
|
||||
|
||||
In **VS Code**, configure GitHub Copilot to use the MCP server:
|
||||
|
||||
1. Create or edit `.vscode/mcp.json` in your workspace or project directory
|
||||
2. Add the following configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"servers": {
|
||||
"influxdb-docs": {
|
||||
"type": "http",
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Restart or reload VS Code
|
||||
4. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
|
||||
5. Run **MCP: List Servers** to verify the server is registered
|
||||
|
||||
The InfluxDB documentation MCP server will now be available through GitHub Copilot Chat.
|
||||
|
||||
<!----------------------------- END GITHUB COPILOT ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN CURSOR ---------------------------->
|
||||
|
||||
In **Cursor**, add the MCP server configuration to your MCP settings file.
|
||||
|
||||
1. Open **Settings** and navigate to **MCP Servers**
|
||||
2. Click **Add MCP Server** or edit the configuration file directly
|
||||
3. Add the following configuration to `.cursor/mcp.json` (project-level) or `~/.cursor/mcp.json` (global):
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"influxdb-docs": {
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai",
|
||||
"transport": "streamableHttp"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Save the file and restart Cursor.
|
||||
|
||||
<!----------------------------- END CURSOR ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{% tab-content %}}
|
||||
<!----------------------------- BEGIN OPENCODE ---------------------------->
|
||||
|
||||
In **OpenCode**, configure the MCP server in your configuration file:
|
||||
|
||||
1. Create or edit `opencode.json` (or `opencode.jsonc`) in your workspace
|
||||
2. Add the following configuration:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://opencode.ai/config.json",
|
||||
"mcp": {
|
||||
"influxdb-docs": {
|
||||
"type": "remote",
|
||||
"url": "https://influxdb-docs.mcp.kapa.ai",
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
3. Start OpenCode and use the `/init` command to verify the MCP server is accessible
|
||||
|
||||
The InfluxDB documentation search tools will be available in your OpenCode sessions.
|
||||
|
||||
<!----------------------------- END OPENCODE ---------------------------->
|
||||
{{% /tab-content %}}
|
||||
{{< /tabs-wrapper >}}
|
||||
|
||||
### Authentication and rate limits
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,18 @@
|
|||
---
|
||||
title: Use the InfluxDB documentation MCP server
|
||||
description: >
|
||||
Query InfluxDB documentation from your IDE using the InfluxDB documentation
|
||||
Query {{% product-name %}} documentation from your IDE using the InfluxDB documentation
|
||||
MCP server.
|
||||
menu:
|
||||
telegraf_v1_ref:
|
||||
name: Documentation MCP server
|
||||
weight: 206
|
||||
tags: [MCP, LLM, AI]
|
||||
alt_links:
|
||||
core: /influxdb3/core/admin/mcp-server/
|
||||
enterprise: /influxdb3/enterprise/admin/mcp-server/
|
||||
cloud-dedicated: /influxdb3/cloud-dedicated/admin/mcp-server/
|
||||
cloud-serverless: /influxdb3/cloud-serverless/reference/mcp-server/
|
||||
source: /shared/influxdb3-admin/mcp-server-docs-only.md
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,32 @@
|
|||
{{- $productPathData := findRE "[^/]+.*?" .Page.RelPermalink -}}
|
||||
{{- /* Support deployments (such as CI tools) with subdirectory baseURL */ -}}
|
||||
{{- $pathOffset := .Site.Params.prPreviewPathOffset | default 0 -}}
|
||||
{{- $namespace := index $productPathData (add $pathOffset 0) -}}
|
||||
{{- $currentProduct := index $productPathData (add $pathOffset 1) -}}
|
||||
{{- $length := .Get 0 | default "long" -}}
|
||||
{{- $omit := .Get "omit" | default "" -}}
|
||||
{{- $scratch := newScratch -}}
|
||||
{{- /* Products identified by second path segment (influxdb, influxdb3) */ -}}
|
||||
{{- if eq $currentProduct "v2" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.influxdb -}}
|
||||
{{- else if eq $currentProduct "v1" -}}
|
||||
{{- /* v1 requires checking namespace to distinguish products */ -}}
|
||||
{{- if eq $namespace "influxdb" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.influxdb -}}
|
||||
{{- else if eq $namespace "enterprise_influxdb" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.enterprise_influxdb -}}
|
||||
{{- else if eq $namespace "telegraf" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.telegraf -}}
|
||||
{{- else if eq $namespace "chronograf" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.chronograf -}}
|
||||
{{- else if eq $namespace "kapacitor" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.kapacitor -}}
|
||||
{{- end -}}
|
||||
{{- else if eq $currentProduct "v0" -}}
|
||||
{{- /* v0 is Flux */ -}}
|
||||
{{- if eq $namespace "flux" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.flux -}}
|
||||
{{- end -}}
|
||||
{{- else if eq $currentProduct "cloud" -}}
|
||||
{{- $scratch.Set "productData" .Site.Data.products.influxdb_cloud -}}
|
||||
{{- else if eq $currentProduct "core" -}}
|
||||
|
|
|
|||
Loading…
Reference in New Issue