Skip to content

Commit 90171df

Browse files
authored
Merge pull request #315 from nocodb/docs/mcp
docs: mcp
2 parents 18d12d4 + 949dcfb commit 90171df

File tree

15 files changed

+140
-3
lines changed

15 files changed

+140
-3
lines changed

components/icons/Mcp.tsx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
export default function Mcp(props: React.SVGProps<SVGSVGElement>) {
2+
return (
3+
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" {...props}>
4+
<defs>
5+
<clipPath id="clip0_7011_10333">
6+
<rect width="16" height="16" rx="2" fill="white" />
7+
</clipPath>
8+
</defs>
9+
<g clipPath="url(#clip0_7011_10333)">
10+
<path
11+
d="M5.64617 9.44949L10.1972 4.89847C11.0069 4.08873 11.0069 2.77589 10.1972 1.96615C9.38745 1.15641 8.07461 1.15641 7.26487 1.96615L1.25 7.98102"
12+
stroke="#1F293A"
13+
strokeWidth="1.33"
14+
strokeLinecap="round"
15+
/>
16+
<path
17+
d="M7.58284 13.5992L10.1626 11.0195L13.1834 7.9987C14.0247 7.15741 14.0247 5.79342 13.1834 4.95213C12.3421 4.11085 10.9781 4.11085 10.1368 4.95213L5.61851 9.47043"
18+
stroke="#1F293A"
19+
strokeWidth="1.33"
20+
strokeLinecap="round"
21+
/>
22+
<path
23+
d="M8.45532 3.71483L7.15276 5.01739L4.10645 8.0637C3.27925 8.89089 3.27925 10.232 4.10645 11.0592C4.93364 11.8864 6.27478 11.8864 7.10198 11.0592L11.6458 6.51541"
24+
stroke="#1F293A"
25+
strokeWidth="1.33"
26+
strokeLinecap="round"
27+
/>
28+
<path
29+
d="M7.51895 14.0675L8.89563 15.5"
30+
stroke="#1F293A"
31+
strokeWidth="1.33"
32+
strokeLinecap="round"
33+
/>
34+
</g>
35+
</svg>
36+
);
37+
}

content/blog/moving-to-playwright-from-cypress-part-1.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ This is the speedup we measured, granted this no way a fair comparison between P
6464
Total **3.87x** speedup 😳
6565

6666

67-
![image](https://media.tenor.com/WXUFUZ5g7uUAAAAC/speed.gif)
67+
![Speed GIF](/img/blog/cypress/speed.gif)
6868

6969
And beyond speed, the ease to develop - debugging tests has improved drastically mainly due to really short feedback loop and really good APIs from the playwright. Also for the first time, many of the developers in the team feel it's a joy to write tests! In conclusion, we think Playwright was a big game changer for us on how fastly we can ship releases.
7070

content/docs/account-settings/oss-specific-details.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Signup without an invitation is disabled by default and can be managed from UI b
1717

1818
App store lists available integrations for NocoDB. You can install and configure these integrations from the App store.
1919

20-
![Screenshot 2023-08-22 at 5 02 26 PM](https://github.com/nocodb/nocodb/assets/86527202/e739a4b6-6ab6-4ee7-aac3-073d3aaf20ac)
20+
![App Store](/img/v2/account-settings/app-store.png)
2121
We provide different integrations in three main categories.
2222

2323
| Category | App Name |

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.mdx

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

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",

lib/iconMap.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import Extension from '@/components/icons/Extension';
2929
import Sparkle from '@/components/icons/Sparkle';
3030
import Chart from '@/components/icons/Chart';
3131
import Legal from '@/components/icons/Legal';
32+
import Mcp from '@/components/icons/Mcp';
3233

3334
const iconMap = {
3435
alertCircle: AlertCircle,
@@ -62,6 +63,7 @@ const iconMap = {
6263
sparkle: Sparkle,
6364
chart: Chart,
6465
legal: Legal,
66+
mcp: Mcp,
6567
} as const;
6668

6769
type IconNameType = keyof typeof iconMap;

public/img/blog/cypress/speed.gif

665 KB
Loading
397 KB
Loading

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

201 KB
Loading

0 commit comments

Comments
 (0)