Nocodb MCP Server

1[![MseeP.ai Security Assessment Badge](https://mseep.net/pr/edwinbernadus-nocodb-mcp-server-badge.jpg)](https://mseep.ai/app/edwinbernadus-nocodb-mcp-server)
2 
3# Nocodb MCP Server
4 
5[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/edwinbernadus/nocodb-mcp-server)](https://archestra.ai/mcp-catalog/edwinbernadus__nocodb-mcp-server)
6[![smithery badge](https://smithery.ai/badge/@edwinbernadus/nocodb-mcp-server)](https://smithery.ai/server/@edwinbernadus/nocodb-mcp-server)
7 
8## Introduction
9 
10The NocoDB MCP Server enables seamless interaction with your NocoDB database using the Model Context Protocol (MCP). This server makes it easy to perform CRUD (Create, Read, Update, Delete) operations on NocoDB tables through natural language commands.
11 
12## Example Prompt
13 
14```text
15[Get Records]
16get data from nocodb, table: Shinobi
17 
18[Create Record]
19add new row, with name: sasuke-2
20add other row, with name: naruto-2
21 
22[Update Record]
23update all rows, remove suffix -
24 
25[Delete Record]
26delete all rows with name naruto
27 
28[Add Column]
29add column with name: Age
30 
31update all rows, set Age to 18
32 
33[Delete Column]
34delete column with name: Age
35```
36 
37## Example Prompt - Upload File
38 
39```text
40[Create table]
41from the json files
42put on nocodb database
43table name is TableShinobi
44```
45JSON location file in: [example_upload.json](example_upload.json)
46 
47## Example Prompt - Bulk Create Records and Bulk Delete Records
48 
49 
50![bulk_sample1](https://raw.githubusercontent.com/edwinbernadus/nocodb-mcp-server/refs/heads/main/docs/sample-bulk/bulk-screen1.png)
51![bulk_sample2](https://raw.githubusercontent.com/edwinbernadus/nocodb-mcp-server/refs/heads/main/docs/sample-bulk/bulk-screen2.png)
52![bulk_sample3](https://raw.githubusercontent.com/edwinbernadus/nocodb-mcp-server/refs/heads/main/docs/sample-bulk/bulk-screen3.png)
53 
54## About This Fork
55 
56This repository is a TypeScript-based fork of [NocoDB-MCP-Server](https://github.com/granthooks/Nocodb-MCP-Server). It retains the core functionality while improving maintainability and compatibility with modern TypeScript development practices.
57 
58## Setup
59 
60Ensure that Node.js and TypeScript are installed, then execute:
61 
62```bash
63npm install
64npm run build
65```
66 
67## Configuration
68 
69Define the required environment variables in a `.env` file:
70 
71```env
72NOCODB_URL=https://your-nocodb-instance.com
73NOCODB_API_TOKEN=your_api_token_here
74NOCODB_BASE_ID=your_base_id_here
75```
76 
77**Tip:** You can copy the template from [env.example](env.example) and fill in your values.
78 
79### How to Obtain NOCODB_BASE_ID
80 
81To find your `NOCODB_BASE_ID`, check the URL of your Nocodb instance.  
82For example:
83https://app.nocodb.com/#/wi6evls6/pqmob3ammcknma5/maty9c5xkmf4012  
84In this URL format:
85 
86```text
87https://app.nocodb.com/#/{USERNAME}/{NOCODB_BASE_ID}/{TABLE_ID}
88```
89 
90## Integration with Claude Desktop
91 
92Modify `claude_desktop_config.json` to include:
93 
94```json
95{
96  "mcpServers": {
97    "nocodb": {
98      "command": "node",
99      "args": ["{working_folder}/dist/start.js"],
100      "env": {
101        "NOCODB_URL": "https://your-nocodb-instance.com",
102        "NOCODB_BASE_ID": "your_base_id_here",
103        "NOCODB_API_TOKEN": "your_api_token_here"
104      }
105    }
106  }
107}
108```
109 
110## Direct call from CLI
111 
112You can directly call the MCP server from the command line:  
113NOCODB_URL, NOCODB_API_TOKEN, and NOCODB_BASE_ID are required parameters.  
114`NOCODB_URL=https://app.nocodb.com` if you are using NocoDB cloud.
115 
116```bash
117npx -y nocodb-mcp-server {NOCODB_URL} {NOCODB_BASE_ID} {NOCODB_API_TOKEN} 
118```
119 
120## Testing CLI
121 
122To run the tests, execute:
123 
124```bash
125npx -y @wong2/mcp-cli npx nocodb-mcp-server {NOCODB_URL} {NOCODB_BASE_ID} {NOCODB_API_TOKEN} 
126```
127 
128## API Functions
129 
130For detailed information about available API functions, please refer to [API_FUNCTION.md](API_FUNCTION.md).
131 
132## Project Structure
133 
134```text
135/project-root
136  ├── src/            # TypeScript source files
137  ├── dist/           # Compiled JavaScript output
138  ├── .env            # Environment variable configurations
139  ├── package.json    # Project dependencies and scripts
140  ├── tsconfig.json   # TypeScript settings
141```
142 
143## Contribution Guidelines
144 
145Contributions are encouraged! Feel free to open issues or submit pull requests.
146 
147## License
148 
149This project is distributed under MIT.
150