Skip to content

Commit 331a1ba

Browse files
Piotr1215Piotr1215
authored
docs: add algolia mcp integration page (#1793)
* docs: add algolia mcp integration page add documentation for connecting AI coding assistants to vCluster docs via the Algolia hosted MCP server. covers Claude Code, Claude.ai, Cursor, and VS Code configuration. Closes DOC-1212 * docs: add actual algolia mcp server url replace placeholder with the real hosted MCP endpoint configured in the algolia dashboard. * docs: rename contribute section to resources, move algolia mcp there the algolia mcp doc is a docs site feature, not a product integration. new "Resources" section groups it with the existing contribute page. * docs: add netlify redirect from contribute to resources existing links to /contribute/ should not break after the section rename. * docs: rename platform contribute section to resources keep both sides consistent. add platform redirects for existing notion/external links. * docs: add algolia mcp page to platform resources same index covers both vcluster and platform docs.
1 parent 948cbb3 commit 331a1ba

7 files changed

Lines changed: 217 additions & 2 deletions

File tree

‎netlify.toml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,23 @@ command = """
2424
# Redirects - Order matters (first match wins)
2525
# Specific paths before wildcards, /next/ stays in /next/
2626

27+
# Renamed sections
28+
[[redirects]]
29+
from = "/docs/vcluster/contribute/*"
30+
to = "/docs/vcluster/resources/:splat"
31+
32+
[[redirects]]
33+
from = "/docs/vcluster/next/contribute/*"
34+
to = "/docs/vcluster/next/resources/:splat"
35+
36+
[[redirects]]
37+
from = "/docs/platform/contribute/*"
38+
to = "/docs/platform/resources/:splat"
39+
40+
[[redirects]]
41+
from = "/docs/platform/next/contribute/*"
42+
to = "/docs/platform/next/resources/:splat"
43+
2744
# Legacy paths
2845
[[redirects]]
2946
from = "/docs/architecture/*"

platform/contribute/_category_.json renamed to platform/resources/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Contribute",
2+
"label": "Resources",
33
"position": "3.1",
44
"collapsible": true,
55
"collapsed": true

‎platform/resources/algolia-mcp.mdx‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Search vCluster docs with Algolia MCP
3+
sidebar_label: Algolia MCP
4+
sidebar_position: 1
5+
description: Connect AI coding assistants to the vCluster documentation index using the Algolia MCP server.
6+
---
7+
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
export const MCP_SERVER_URL = "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp";
12+
13+
AI coding assistants that support the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) can
14+
query the vCluster documentation directly from your editor or chat interface. This uses Algolia's
15+
[hosted MCP server](https://www.algolia.com/doc/guides/model-context-protocol/public-mcp), which connects
16+
to the same search index that powers the vCluster docs site search.
17+
18+
## Available tools
19+
20+
The MCP server exposes two tools:
21+
22+
- **algolia_search_vcluster** - Full-text search across vCluster documentation.
23+
- **algolia_search_for_facet_values** - Filter results by facets such as version or section.
24+
25+
Access is read-only. No data is modified through this integration.
26+
27+
## Configure your AI tool
28+
29+
Add the vCluster docs MCP server to your AI assistant of choice.
30+
31+
<Tabs>
32+
<TabItem value="claude-code" label="Claude Code">
33+
34+
Add to your project's `.mcp.json` or global `~/.claude.json`:
35+
36+
```json
37+
{
38+
"mcpServers": {
39+
"vcluster-docs": {
40+
"url": "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp"
41+
}
42+
}
43+
}
44+
```
45+
46+
</TabItem>
47+
<TabItem value="claude-ai" label="Claude.ai">
48+
49+
1. Go to **Settings** > **Integrations** > **Add MCP Server**.
50+
1. Enter the server URL:
51+
52+
```
53+
https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp
54+
```
55+
56+
</TabItem>
57+
<TabItem value="cursor" label="Cursor">
58+
59+
Add to `~/.cursor/mcp.json`:
60+
61+
```json
62+
{
63+
"mcpServers": {
64+
"vcluster-docs": {
65+
"url": "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp"
66+
}
67+
}
68+
}
69+
```
70+
71+
</TabItem>
72+
<TabItem value="vscode" label="VS Code">
73+
74+
Add to `~/.vscode/mcp.json`:
75+
76+
```json
77+
{
78+
"servers": {
79+
"vcluster-docs": {
80+
"type": "http",
81+
"url": "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp"
82+
}
83+
}
84+
}
85+
```
86+
87+
</TabItem>
88+
</Tabs>
89+
90+
No API keys or authentication tokens are needed. The server URL is the only configuration required.
91+
92+
## Usage tips
93+
94+
Once configured, your AI assistant can search the vCluster docs when answering questions.
95+
Most MCP-aware tools call the search automatically based on your prompt. You can also reference
96+
the tool directly, for example by asking your assistant to "search the vCluster docs for sleep mode configuration."
97+
98+
To search within a specific docs version, ask your assistant to filter by version facet. For example:
99+
"Search vCluster docs for pod syncing in version 0.22."

platform/contribute/contribute.mdx renamed to platform/resources/contribute.mdx

File renamed without changes.

vcluster/contribute/_category_.json renamed to vcluster/resources/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Contribute",
2+
"label": "Resources",
33
"position": "13",
44
"collapsible": true
55
}

‎vcluster/resources/algolia-mcp.mdx‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Search vCluster docs with Algolia MCP
3+
sidebar_label: Algolia MCP
4+
sidebar_position: 1
5+
description: Connect AI coding assistants to the vCluster documentation index using the Algolia MCP server.
6+
---
7+
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
export const MCP_SERVER_URL = "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp";
12+
13+
AI coding assistants that support the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) can
14+
query the vCluster documentation directly from your editor or chat interface. This uses Algolia's
15+
[hosted MCP server](https://www.algolia.com/doc/guides/model-context-protocol/public-mcp), which connects
16+
to the same search index that powers the vCluster docs site search.
17+
18+
## Available tools
19+
20+
The MCP server exposes two tools:
21+
22+
- **algolia_search_vcluster** - Full-text search across vCluster documentation.
23+
- **algolia_search_for_facet_values** - Filter results by facets such as version or section.
24+
25+
Access is read-only. No data is modified through this integration.
26+
27+
## Configure your AI tool
28+
29+
Add the vCluster docs MCP server to your AI assistant of choice.
30+
31+
<Tabs>
32+
<TabItem value="claude-code" label="Claude Code">
33+
34+
Add to your project's `.mcp.json` or global `~/.claude.json`:
35+
36+
```json
37+
{
38+
"mcpServers": {
39+
"vcluster-docs": {
40+
"url": "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp"
41+
}
42+
}
43+
}
44+
```
45+
46+
</TabItem>
47+
<TabItem value="claude-ai" label="Claude.ai">
48+
49+
1. Go to **Settings** > **Integrations** > **Add MCP Server**.
50+
1. Enter the server URL:
51+
52+
```
53+
https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp
54+
```
55+
56+
</TabItem>
57+
<TabItem value="cursor" label="Cursor">
58+
59+
Add to `~/.cursor/mcp.json`:
60+
61+
```json
62+
{
63+
"mcpServers": {
64+
"vcluster-docs": {
65+
"url": "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp"
66+
}
67+
}
68+
}
69+
```
70+
71+
</TabItem>
72+
<TabItem value="vscode" label="VS Code">
73+
74+
Add to `~/.vscode/mcp.json`:
75+
76+
```json
77+
{
78+
"servers": {
79+
"vcluster-docs": {
80+
"type": "http",
81+
"url": "https://mcp.eu.algolia.com/1/VR12oimCRMyH3BKzGU2jVw/mcp"
82+
}
83+
}
84+
}
85+
```
86+
87+
</TabItem>
88+
</Tabs>
89+
90+
No API keys or authentication tokens are needed. The server URL is the only configuration required.
91+
92+
## Usage tips
93+
94+
Once configured, your AI assistant can search the vCluster docs when answering questions.
95+
Most MCP-aware tools call the search automatically based on your prompt. You can also reference
96+
the tool directly, for example by asking your assistant to "search the vCluster docs for sleep mode configuration."
97+
98+
To search within a specific docs version, ask your assistant to filter by version facet. For example:
99+
"Search vCluster docs for pod syncing in version 0.22."

vcluster/contribute/contribute.mdx renamed to vcluster/resources/contribute.mdx

File renamed without changes.

0 commit comments

Comments
 (0)