Skip to content

Commit db27b1d

Browse files
committed
docs: mcp
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
1 parent 888a482 commit db27b1d

File tree

10 files changed

+106
-1
lines changed

10 files changed

+106
-1
lines changed

content/docs/bases/meta.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"share-base",
77
"snapshots",
88
"private-base",
9-
"actions-on-base"],
9+
"actions-on-base"
10+
],
1011
"icon": "baseOutlineLogo"
1112
}

content/docs/mcp/index.mdx

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: MCP Server
3+
description: Connect NocoDB to Large Language Models (LLMs) via the Model Context Protocol (MCP).
4+
tags: ["MCP", "LLM", "AI", "Claude", "Cursor", "Windsurf"]
5+
keywords: ["MCP", "Model Context Protocol", "NocoDB MCP", "LLM Integration", "Claude", "Cursor", "Windsurf"]
6+
---
7+
8+
## Getting Started
9+
10+
The **Model Context Protocol (MCP) Server** lets you connect NocoDB with LLMs that support MCP, such as Claude, Cursor, or Windsurf. With this integration, LLMs can interact directly with your NocoDB workspace to create, query, update, and manage records.
11+
12+
Each MCP endpoint in NocoDB provides a secure URL that can be linked to an MCP-compatible client.
13+
Once configured, the LLM can execute database operations in your workspace through natural language prompts.
14+
15+
<Callout type="info"> The MCP integration currently works only with desktop clients that support MCP. Support for web based clients is coming soon. </Callout>
16+
17+
MCP server exposes standard CRUD operations. These can be triggered conversationally, without writing SQL or scripts.
18+
19+
| Action | Purpose | Sample Prompt |
20+
|--------|----------------------|---------------------------------------------------------------|
21+
| Create | Add new records | Create a task named ‘Review Documentation’ |
22+
| Read | Look up information | Show me all projects with deadlines this week |
23+
| Update | Change existing data | Mark the status of Project X as completed & re-assign to John |
24+
| Delete | Remove records | Remove all tasks assigned to John |
25+
26+
27+
## Server Configuration (NocoDB)
28+
29+
1. Click on the **Overview** button in the left sidebar.
30+
2. Select the **Settings** tab.
31+
3. Select the **Model Context Protocol**
32+
4. Click on the **New MCP Endpoint** to create a new MCP config JSON for your base.
33+
5. Provide a name for the MCP endpoint
34+
6. Click **Create** to generate the MCP Config JSON.
35+
7. Copy the generated JSON configuration. This will be used in your LLM client configuration.
36+
37+
![MCP Config](/img/v2/mcp/server-configuration.png)
38+
39+
![MCP Config](/img/v2/mcp/server-configuration-2.png)
40+
41+
42+
## Client Configuration
43+
44+
### Claude
45+
46+
1. Open **Claude Desktop Preferences** (`⌘+,`).
47+
2. Under **Develop**, click **Edit Config**.
48+
3. Insert the JSON block copied [here](#server-configuration-nocodb) as `claude_desktop_config.json`.
49+
4. Save the file and restart Claude Desktop.
50+
51+
52+
### Cursor
53+
54+
1. Go to **Cursor Settings** (`⇧+⌘+J`).
55+
2. Open the **MCP** tab and select **Add Custom MCP**.
56+
3. Paste the JSON block copied [here](#server-configuration-nocodb). Save.
57+
58+
<Callout type="info"> On success, you will see `11 tools enabled` below the MCP Server just installed. If you see an error, double-check the JSON configuration. </Callout>
59+
60+
![Cursor MCP Settings](/img/v2/mcp/cursor-mcp.png)
61+
62+
63+
### Windsurf
64+
65+
1. Open **Windsurf Settings** (`⌘+,`).
66+
2. In the **Cascade** section > `Plugins (MCP Server)` > Click **Manage Plugins**
67+
3. Paste the JSON block copied [here](#server-configuration-nocodb). Save.
68+
69+
![Windsurf MCP Settings](/img/v2/mcp/windsurf-mcp-1.png)
70+
71+
![Windsurf MCP Settings](/img/v2/mcp/windsurf-mcp-2.png)
72+
73+
74+
## JSON Example
75+
76+
```json
77+
{
78+
"mcpServers": {
79+
"NocoDB MCP": {
80+
"command": "npx",
81+
"args": [
82+
"mcp-remote",
83+
"https://your-domain.com/mcp/<ncId>",
84+
"--header",
85+
"xc-mcp-token: <ncToken>"
86+
]
87+
}
88+
}
89+
}
90+
91+
````
92+
93+
<Callout type="warning"> Your MCP configurations generated above functions as a set of access credentials, granting full control over your NocoDB base. Ensure it remains confidential, never include it in source control, and store it only in secure, protected locations.</Callout>
94+
95+
---
96+
97+

content/docs/mcp/meta.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"title": "MCP Server",
3+
"pages": [
4+
],
5+
"icon": "plug"
6+
}

content/docs/meta.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"noco-ai",
1616
"extensions",
1717
"dashboards",
18+
"mcp",
1819
"roles-and-permissions",
1920
"collaboration",
2021
"automation",

public/img/v2/mcp/cursor-mcp.png

201 KB
Loading
243 KB
Loading
158 KB
Loading
250 KB
Loading
176 KB
Loading
200 KB
Loading

0 commit comments

Comments
 (0)