Skip to content

Commit 51350c3

Browse files
Merge pull request #367 from nocodb/docs/mcp-2
2 parents d887b00 + 11c64dd commit 51350c3

File tree

15 files changed

+256
-18
lines changed

15 files changed

+256
-18
lines changed

content/docs/developer-resources/mcp.mdx

Lines changed: 128 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ tags: ["MCP", "LLM", "AI", "Claude", "Cursor", "Windsurf"]
55
keywords: ["MCP", "Model Context Protocol", "NocoDB MCP", "LLM Integration", "Claude", "Cursor", "Windsurf"]
66
---
77

8-
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.
8+
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 base to create, query, update, and manage records.
9+
10+
## Desktop LLM Clients
911

1012
Each MCP endpoint in NocoDB provides a secure URL that can be linked to an MCP-compatible client.
1113
Once configured, the LLM can execute database operations in your workspace through natural language prompts.
1214

13-
<Callout type="info"> The MCP integration currently works only with desktop clients that support MCP. Support for web based clients is coming soon. </Callout>
14-
1515
MCP server exposes standard CRUD operations. These can be triggered conversationally, without writing SQL or scripts.
1616

1717
| Action | Purpose | Sample Prompt |
@@ -23,7 +23,7 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
2323

2424
<Callout type="note"> NocoDB MCP supports only record-level operations and does not handle table, field, or other metadata changes. </Callout>
2525

26-
## Server Configuration (NocoDB)
26+
### Server Configuration (NocoDB)
2727

2828
1. Click on the **Overview** button in the left sidebar.
2929
2. Select the **Settings** tab.
@@ -38,17 +38,17 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
3838
![MCP Config](/img/v2/mcp/server-configuration-2.png)
3939

4040

41-
## Client Configuration
41+
### Client Configuration
4242

43-
### Claude
43+
#### Claude
4444

4545
1. Open **Claude Desktop Preferences** (`⌘+,`).
4646
2. Under **Develop**, click **Edit Config**.
4747
3. Insert the JSON block copied [here](#server-configuration-nocodb) as `claude_desktop_config.json`.
4848
4. Save the file and restart Claude Desktop.
4949

5050

51-
### Cursor
51+
#### Cursor
5252

5353
1. Go to **Cursor Settings** (`⇧+⌘+J`).
5454
2. Open the **MCP** tab and select **Add Custom MCP**.
@@ -59,7 +59,7 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
5959
![Cursor MCP Settings](/img/v2/mcp/cursor-mcp.png)
6060

6161

62-
### Windsurf
62+
#### Windsurf
6363

6464
1. Open **Windsurf Settings** (`⌘+,`).
6565
2. In the **Cascade** section > `Plugins (MCP Server)` > Click **Manage Plugins**
@@ -70,7 +70,7 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
7070
![Windsurf MCP Settings](/img/v2/mcp/windsurf-mcp-2.png)
7171

7272

73-
## JSON Example
73+
### JSON Example
7474

7575
```json
7676
{
@@ -93,4 +93,123 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
9393

9494
---
9595

96+
## Web based LLM Clients (OAuth)
97+
98+
Connect NocoDB to web-based LLM applications using OAuth, enabling seamless database access directly from the browser without requiring desktop client setup. This approach grants granular permission controls and eliminates the need for manual JSON configuration.
99+
100+
### Claude Web
101+
102+
OAuth-based integration allows Claude web users to access NocoDB databases through the connectors interface.
103+
104+
#### Setup Steps
105+
106+
1. Click [here](https://claude.ai/settings/connectors) to open Claude Web Settings in a new tab.
107+
- Alternatively, navigate to **Settings** > **Connectors** from the Claude Web app.
108+
2. Click **Add custom connector**.
109+
![open-connectors](/img/v2/mcp/web-app/claude/open-connectors.png)
110+
3. In the "Add custom connector" dialog:
111+
- Provide a connector name of your choice
112+
- Enter the MCP endpoint URL: `https://app.nocodb.com/mcp`
113+
- Click `Add`
114+
![add-connector-dialog](/img/v2/mcp/web-app/claude/add-connector-dialog.png)
115+
4. NocoDB Connector will now be listed in "Disconnected" state. Click **Connect** to initiate the OAuth authorization flow (Opens in a new tab).
116+
![add-connector](/img/v2/mcp/web-app/claude/connect.png)
117+
5. Authorize Access
118+
- You will be asked to log in to your NocoDB account (if not already logged in)
119+
- Select the workspace and base you want to connect
120+
- Confirm the permissions Claude will have
121+
- Access the selected base
122+
- Read / create / update / delete records in the selected base
123+
- Act on your behalf within the selected resources
124+
- Click **Authorize** to grant access
125+
![authorize-access](/img/v2/mcp/web-app/claude/authorize-access.png)
126+
127+
With this, the NocoDB connector will move to "Connected" state in Claude Web. You can now interact with your NocoDB data through Claude web application.
128+
129+
<Callout type="note"> On-prem enterprise users should replace https://app.nocodb.com with their NocoDB instance URL</Callout>
130+
131+
#### Configure Tool Permissions
132+
By default, all tools are set to "Always ask permission" to ensure you have control over each operation Claude performs. You can modify these settings as needed.
133+
134+
Click [here](https://claude.ai/settings/connectors) to open Claude Web Settings in a new tab. Click **Configure** on the NocoDB connector to manage tool permissions. Set each tool's permission level using the dropdown menu:
135+
136+
- **Always ask permission** — Your approval is required every time Claude uses this tool
137+
- **Allow unsupervised** — Claude can use this tool without requesting approval
138+
139+
![tool-permissions](/img/v2/mcp/web-app/claude/configure.png)
140+
![tool-permissions](/img/v2/mcp/web-app/claude/tool-permissions.png)
141+
142+
To retrieve Workspace & Base information that this connector has access to, use the "Get Base Info" tool.
143+
![get-base-info](/img/v2/mcp/web-app/claude/get-base-info.png)
144+
145+
#### Using NocoDB Tools in Claude Web
146+
147+
Once configured, you can interact with your NocoDB data conversationally. For example:
148+
149+
- "Show me all projects with deadlines this week"
150+
- "Create a task named 'Review Documentation'"
151+
- "Mark the status of Project X as completed and reassign to John"
152+
- "Provide details of our top 3 sponsors"
153+
154+
Claude will execute these requests using the enabled NocoDB tools, reading from and writing to your database based on the permissions you've granted.
96155

156+
![connected-connector](/img/v2/mcp/web-app/claude/demo.png)
157+
158+
<Callout type="warning">OAuth authorization functions as a set of access credentials granting Claude control over your NocoDB base within the selected workspace. Only authorize access to bases and operations you trust Claude to perform on your behalf.</Callout>
159+
160+
161+
### OpenAI Web
162+
163+
OAuth-based integration enables OpenAI web users (ChatGPT) to securely connect with NocoDB databases through the MCP connector, directly from their browser environment. This provides the same granular access control and eliminates the need for manual configuration or desktop client setup.
164+
165+
#### Prerequisites
166+
Enable Developer Mode in ChatGPT settings to allow custom connector additions.
167+
1. Open [ChatGPT Settings](https://chatgpt.com/#settings/Connectors) in a new tab.
168+
* Alternatively, click your **Profile Icon** → **Settings** → **Settings** → **Apps & Connectors**).
169+
2. Click **Advanced Settings** & enable **Developer Mode**.
170+
171+
![open-connectors](/img/v2/mcp/web-app/chatgpt/developer.png)
172+
173+
#### Setup Steps
174+
1. Open [ChatGPT Settings](https://chatgpt.com/#settings/Connectors) in a new tab.
175+
* Alternatively, click your **Profile Icon** → **Settings** → **Settings** → **Apps & Connectors**).
176+
2. Click **Create** button in top right corner of the **Connectors** modal.
177+
3. In the "New connector" dialog:
178+
- Provide a connector name of your choice. Optionally, add a description / icon.
179+
- Enter the MCP Server URL: `https://app.nocodb.com/mcp`
180+
- Check the box for **I trust this application**.
181+
- Click `Create`
182+
![new-connector](/img/v2/mcp/web-app/chatgpt/create-connector.png)
183+
4. Authorize Access:
184+
* Log in to your NocoDB account if prompted
185+
* Select the workspace and base you want to connect
186+
* Review and confirm the permissions being requested:
187+
* Access to the selected base
188+
* Read / create / update / delete records
189+
* Act on your behalf within the selected resources
190+
* Click **Authorize**
191+
192+
Once authorization completes, you will see a confirmation message in ChatGPT Web indicating the NocoDB connector is now connected.
193+
![connected](/img/v2/mcp/web-app/chatgpt/connected.png)
194+
195+
<Callout type="note">For on-prem enterprise users, replace `https://app.nocodb.com` with your NocoDB instance URL.</Callout>
196+
197+
#### Using NocoDB Tools in OpenAI Web
198+
199+
On the ChatGPT interface, start a new conversation and
200+
- Click the **+** icon to open the "Tools" menu, enable `Developer Mode` if not already enabled.
201+
- Click `More` to find and select the NocoDB connector you created. Toggle to enable it.
202+
![using-connector](/img/v2/mcp/web-app/chatgpt/using-chat.png)
203+
204+
Once configured, you can query or update your NocoDB data conversationally. For example:
205+
206+
* “List all open support tickets assigned to me”
207+
* “Add a new contact named ‘Alice Chen’ to the CRM base”
208+
* “Update the status of Order #2456 to ‘Shipped’”
209+
* “Summarize total revenue by month from the Sales base”
210+
211+
ChatGPT executes these actions using the connected NocoDB tools according to the permissions granted.
212+
213+
<Callout type="warning">OAuth authorization provides ChatGPT controlled access to your NocoDB base within the selected workspace. Only authorize operations and bases you trust ChatGPT to manage on your behalf.</Callout>
214+
215+
---

content/docs/mcp.mdx

Lines changed: 128 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ keywords: ["MCP", "Model Context Protocol", "NocoDB MCP", "LLM Integration", "Cl
66
icon: 'mcp'
77
---
88

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.
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 base to create, query, update, and manage records.
10+
11+
## Desktop LLM Clients
1012

1113
Each MCP endpoint in NocoDB provides a secure URL that can be linked to an MCP-compatible client.
1214
Once configured, the LLM can execute database operations in your workspace through natural language prompts.
1315

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-
1616
MCP server exposes standard CRUD operations. These can be triggered conversationally, without writing SQL or scripts.
1717

1818
| Action | Purpose | Sample Prompt |
@@ -24,7 +24,7 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
2424

2525
<Callout type="note"> NocoDB MCP supports only record-level operations and does not handle table, field, or other metadata changes. </Callout>
2626

27-
## Server Configuration (NocoDB)
27+
### Server Configuration (NocoDB)
2828

2929
1. Click on the **Overview** button in the left sidebar.
3030
2. Select the **Settings** tab.
@@ -39,17 +39,17 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
3939
![MCP Config](/img/v2/mcp/server-configuration-2.png)
4040

4141

42-
## Client Configuration
42+
### Client Configuration
4343

44-
### Claude
44+
#### Claude
4545

4646
1. Open **Claude Desktop Preferences** (`⌘+,`).
4747
2. Under **Develop**, click **Edit Config**.
4848
3. Insert the JSON block copied [here](#server-configuration-nocodb) as `claude_desktop_config.json`.
4949
4. Save the file and restart Claude Desktop.
5050

5151

52-
### Cursor
52+
#### Cursor
5353

5454
1. Go to **Cursor Settings** (`⇧+⌘+J`).
5555
2. Open the **MCP** tab and select **Add Custom MCP**.
@@ -60,7 +60,7 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
6060
![Cursor MCP Settings](/img/v2/mcp/cursor-mcp.png)
6161

6262

63-
### Windsurf
63+
#### Windsurf
6464

6565
1. Open **Windsurf Settings** (`⌘+,`).
6666
2. In the **Cascade** section > `Plugins (MCP Server)` > Click **Manage Plugins**
@@ -71,7 +71,7 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
7171
![Windsurf MCP Settings](/img/v2/mcp/windsurf-mcp-2.png)
7272

7373

74-
## JSON Example
74+
### JSON Example
7575

7676
```json
7777
{
@@ -94,4 +94,123 @@ MCP server exposes standard CRUD operations. These can be triggered conversation
9494

9595
---
9696

97+
## Web based LLM Clients (OAuth)
98+
99+
Connect NocoDB to web-based LLM applications using OAuth, enabling seamless database access directly from the browser without requiring desktop client setup. This approach grants granular permission controls and eliminates the need for manual JSON configuration.
100+
101+
### Claude Web
102+
103+
OAuth-based integration allows Claude web users to access NocoDB databases through the connectors interface.
104+
105+
#### Setup Steps
106+
107+
1. Click [here](https://claude.ai/settings/connectors) to open Claude Web Settings in a new tab.
108+
- Alternatively, navigate to **Settings** > **Connectors** from the Claude Web app.
109+
2. Click **Add custom connector**.
110+
![open-connectors](/img/v2/mcp/web-app/claude/open-connectors.png)
111+
3. In the "Add custom connector" dialog:
112+
- Provide a connector name of your choice
113+
- Enter the MCP endpoint URL: `https://app.nocodb.com/mcp`
114+
- Click `Add`
115+
![add-connector-dialog](/img/v2/mcp/web-app/claude/add-connector-dialog.png)
116+
4. NocoDB Connector will now be listed in "Disconnected" state. Click **Connect** to initiate the OAuth authorization flow (Opens in a new tab).
117+
![add-connector](/img/v2/mcp/web-app/claude/connect.png)
118+
5. Authorize Access
119+
- You will be asked to log in to your NocoDB account (if not already logged in)
120+
- Select the workspace and base you want to connect
121+
- Confirm the permissions Claude will have
122+
- Access the selected base
123+
- Read / create / update / delete records in the selected base
124+
- Act on your behalf within the selected resources
125+
- Click **Authorize** to grant access
126+
![authorize-access](/img/v2/mcp/web-app/claude/authorize-access.png)
127+
128+
With this, the NocoDB connector will move to "Connected" state in Claude Web. You can now interact with your NocoDB data through Claude web application.
129+
130+
<Callout type="note"> On-prem enterprise users should replace https://app.nocodb.com with their NocoDB instance URL</Callout>
131+
132+
#### Configure Tool Permissions
133+
By default, all tools are set to "Always ask permission" to ensure you have control over each operation Claude performs. You can modify these settings as needed.
134+
135+
Click [here](https://claude.ai/settings/connectors) to open Claude Web Settings in a new tab. Click **Configure** on the NocoDB connector to manage tool permissions. Set each tool's permission level using the dropdown menu:
136+
137+
- **Always ask permission** — Your approval is required every time Claude uses this tool
138+
- **Allow unsupervised** — Claude can use this tool without requesting approval
139+
140+
![tool-permissions](/img/v2/mcp/web-app/claude/configure.png)
141+
![tool-permissions](/img/v2/mcp/web-app/claude/tool-permissions.png)
142+
143+
To retrieve Workspace & Base information that this connector has access to, use the "Get Base Info" tool.
144+
![get-base-info](/img/v2/mcp/web-app/claude/get-base-info.png)
145+
146+
#### Using NocoDB Tools in Claude Web
147+
148+
Once configured, you can interact with your NocoDB data conversationally. For example:
149+
150+
- "Show me all projects with deadlines this week"
151+
- "Create a task named 'Review Documentation'"
152+
- "Mark the status of Project X as completed and reassign to John"
153+
- "Provide details of our top 3 sponsors"
154+
155+
Claude will execute these requests using the enabled NocoDB tools, reading from and writing to your database based on the permissions you've granted.
97156

157+
![connected-connector](/img/v2/mcp/web-app/claude/demo.png)
158+
159+
<Callout type="warning">OAuth authorization functions as a set of access credentials granting Claude control over your NocoDB base within the selected workspace. Only authorize access to bases and operations you trust Claude to perform on your behalf.</Callout>
160+
161+
162+
### OpenAI Web
163+
164+
OAuth-based integration enables OpenAI web users (ChatGPT) to securely connect with NocoDB databases through the MCP connector, directly from their browser environment. This provides the same granular access control and eliminates the need for manual configuration or desktop client setup.
165+
166+
#### Prerequisites
167+
Enable Developer Mode in ChatGPT settings to allow custom connector additions.
168+
1. Open [ChatGPT Settings](https://chatgpt.com/#settings/Connectors) in a new tab.
169+
* Alternatively, click your **Profile Icon** → **Settings** → **Settings** → **Apps & Connectors**).
170+
2. Click **Advanced Settings** & enable **Developer Mode**.
171+
172+
![open-connectors](/img/v2/mcp/web-app/chatgpt/developer.png)
173+
174+
#### Setup Steps
175+
1. Open [ChatGPT Settings](https://chatgpt.com/#settings/Connectors) in a new tab.
176+
* Alternatively, click your **Profile Icon** → **Settings** → **Settings** → **Apps & Connectors**).
177+
2. Click **Create** button in top right corner of the **Connectors** modal.
178+
3. In the "New connector" dialog:
179+
- Provide a connector name of your choice. Optionally, add a description / icon.
180+
- Enter the MCP Server URL: `https://app.nocodb.com/mcp`
181+
- Check the box for **I trust this application**.
182+
- Click `Create`
183+
![new-connector](/img/v2/mcp/web-app/chatgpt/create-connector.png)
184+
4. Authorize Access:
185+
* Log in to your NocoDB account if prompted
186+
* Select the workspace and base you want to connect
187+
* Review and confirm the permissions being requested:
188+
* Access to the selected base
189+
* Read / create / update / delete records
190+
* Act on your behalf within the selected resources
191+
* Click **Authorize**
192+
193+
Once authorization completes, you will see a confirmation message in ChatGPT Web indicating the NocoDB connector is now connected.
194+
![connected](/img/v2/mcp/web-app/chatgpt/connected.png)
195+
196+
<Callout type="note">For on-prem enterprise users, replace `https://app.nocodb.com` with your NocoDB instance URL.</Callout>
197+
198+
#### Using NocoDB Tools in OpenAI Web
199+
200+
On the ChatGPT interface, start a new conversation and
201+
- Click the **+** icon to open the "Tools" menu, enable `Developer Mode` if not already enabled.
202+
- Click `More` to find and select the NocoDB connector you created. Toggle to enable it.
203+
![using-connector](/img/v2/mcp/web-app/chatgpt/using-chat.png)
204+
205+
Once configured, you can query or update your NocoDB data conversationally. For example:
206+
207+
* “List all open support tickets assigned to me”
208+
* “Add a new contact named ‘Alice Chen’ to the CRM base”
209+
* “Update the status of Order #2456 to ‘Shipped’”
210+
* “Summarize total revenue by month from the Sales base”
211+
212+
ChatGPT executes these actions using the connected NocoDB tools according to the permissions granted.
213+
214+
<Callout type="warning">OAuth authorization provides ChatGPT controlled access to your NocoDB base within the selected workspace. Only authorize operations and bases you trust ChatGPT to manage on your behalf.</Callout>
215+
216+
---
238 KB
Loading
236 KB
Loading
188 KB
Loading
189 KB
Loading
202 KB
Loading
188 KB
Loading
183 KB
Loading
202 KB
Loading

0 commit comments

Comments
 (0)