Skip to content

Commit 91737fd

Browse files
committed
docs: claude
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
1 parent 4d084d6 commit 91737fd

File tree

10 files changed

+74
-9
lines changed

10 files changed

+74
-9
lines changed

content/docs/mcp.mdx

Lines changed: 74 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,69 @@ 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+
- 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.
155+
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+
### OpenAI Web
97161

162+
OAuth-based integration allows OpenAI ChatGPT users to access NocoDB databases through the custom actions interface.
202 KB
Loading
188 KB
Loading
183 KB
Loading
205 KB
Loading
171 KB
Loading
333 KB
Loading
311 KB
Loading
174 KB
Loading
269 KB
Loading

0 commit comments

Comments
 (0)