Nocodb MCP Server

🚀 Nocodb MCP Server

The Nocodb MCP Server enables seamless interaction with Nocodb databases via the Model Context Protocol (MCP), supporting CRUD operations on Nocodb tables.

🚀 Quick Start

The Nocodb MCP Server allows users to interact seamlessly with Nocodb databases through the Model Context Protocol (MCP). It supports CRUD (Create, Read, Update, Delete) operations on Nocodb tables.

💻 Usage Examples

Basic Usage

[Get Records]
Retrieve data from nocodb, table: Shinobi

[Create Records]
Add a new row with the name: sasuke-2
Add another row with the name: naruto-2

[Update Records]
Update all rows, remove the suffix -

[Delete Records]
Delete all rows with the name naruto

[Add Column]
Add a column named: Age

Update all rows, set Age to 18

[Delete Column]
Delete the column named: Age

Upload File Example

[Create Table]
From a json file
Place it in the nocodb database
The table name is TableShinobi

The location of the json file is: example_upload.json

Bulk Creation and Deletion Examples

📚 Documentation

This repository is a TypeScript-based fork of Nocodb-MCP-Server. It retains the core functionality while improving maintainability and compatibility with modern TypeScript development practices.

📦 Installation

Make sure Node.js and TypeScript are installed, then execute the following commands:

npm install
npm run build

🔧 Configuration

Define the required environment variables in the .env file:

NOCODB_URL=https://your-nocodb-instance.com
NOCODB_API_TOKEN=your_api_token_here
NOCODB_BASE_ID=your_base_id_here

Tip: Copy from the file env.example

How to Get NOCODB_BASE_ID

To find the NOCODB_BASE_ID, check the URL of your Nocodb instance. For example: https://app.nocodb.com/#/wi6evls6/pqmob3ammcknma5/maty9c5xkmf401 Here, maty9c5xkmf401 is the NOCODB_BASE_ID.

🔌 Integration

VS Code Extension

To improve development efficiency, you can install the vscode-nocodb extension. This extension supports the following features:

• Database resource management
• Table structure viewing
• Data preview
• Quick access to documentation

Postman Integration

For convenient API testing, it is recommended to use Postman. You can create a dedicated workspace for Nocodb in it and get started quickly through the following steps:

1. Add a new request.
2. Set appropriate request headers and parameters.
3. Send the request and view the response.

📁 Project Structure

- config/：Contains server configuration files
- routes/：Defines API routes
- controllers/：Controllers for handling specific business logic
- models/：Database model definitions
- public/：Static resource files

📖 Citation

If this project helps you, you are welcome to cite it in your project:

@article{ nocodb-mcp-server,
  title={Nocodb MCP Server},
  author={Edwin Bernadus},
  year={2023},
  publisher={GitHub}
}

📄 License

This project is distributed under the MIT License.