NocoDB

What is NocoDB MCP Server?

The NocoDB MCP Server is a TypeScript-based application that facilitates interaction with NocoDB databases using the Model Context Protocol (MCP). It allows users to perform CRUD (Create, Read, Update, Delete) operations on NocoDB tables through natural language commands.

How to use NocoDB MCP Server?

To use the NocoDB MCP Server, you need to have Node.js and TypeScript installed. After cloning the repository, install dependencies and build the project using npm install and npm run build. Configuration involves setting environment variables in a .env file, including NOCODB_URL, NOCODB_API_TOKEN, and NOCODB_BASE_ID. The server can be integrated with Claude Desktop by modifying claude_desktop_config.json or called directly from the command line.

Key Features of NocoDB MCP Server

• Natural Language Interaction: Perform database operations using simple, human-readable commands.
• CRUD Operations: Supports Create, Read, Update, and Delete operations on NocoDB tables.
• File Uploads: Create tables from JSON files.
• Bulk Operations: Efficiently handle bulk creation and deletion of records.
• TypeScript Based: Improved maintainability and compatibility with modern development practices.
• CLI Support: Direct command-line interface for interaction.

Use Cases of NocoDB MCP Server

• Automated Database Management: Automate routine database tasks through natural language commands.
• Data Migration: Easily create tables and import data from JSON files.
• Rapid Prototyping: Quickly interact with NocoDB for development and testing.
• Integration with AI Tools: Seamlessly integrate NocoDB with tools like Claude Desktop for enhanced data interaction.

FAQ about NocoDB MCP Server

Q: What is NocoDB? A: NocoDB is an open-source, no-code database platform that turns any database into a smart spreadsheet.

Q: How do I get my NOCODB_BASE_ID? A: Your NOCODB_BASE_ID can be found in the URL of your NocoDB instance. For example, in https://app.nocodb.com/#/{USERNAME}/{NOCODB_BASE_ID}/{TABLE_ID}, the NOCODB_BASE_ID is the second part of the path.

Q: Can I contribute to the NocoDB MCP Server project? A: Yes, contributions are encouraged. You can open issues or submit pull requests on the project's GitHub repository.

Q: What license is the NocoDB MCP Server distributed under? A: The project is distributed under the MIT License.

NocoDB MCP Server

Introduction

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

Example Prompt

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

[Create Record]
add new row, with name: sasuke-2
add other row, with name: naruto-2

[Update Record]
update all rows, remove suffix -

[Delete Record]
delete all rows with name naruto

[Add Column]
add column with name: Age

update all rows, set Age to 18

[Delete Column]
delete column with name: Age

Example Prompt - Upload File

[Create table]
from the json files
put on nocodb database
table name is TableShinobi

JSON location file in: example_upload.json

Example Prompt - Bulk Create Records and Bulk Delete Records

About This Fork

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.

Setup

Ensure that Node.js and TypeScript are installed, then execute:

npm install
npm run build

Configuration

Define the required environment variables in a .env file:

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

Tip: You can copy the template from env.example and fill in your values.

How to Obtain NOCODB_BASE_ID

To find your NOCODB_BASE_ID, check the URL of your Nocodb instance.
For example: https://app.nocodb.com/#/wi6evls6/pqmob3ammcknma5/maty9c5xkmf4012
In this URL format:

https://app.nocodb.com/#/{USERNAME}/{NOCODB_BASE_ID}/{TABLE_ID}

Integration with Claude Desktop

Modify claude_desktop_config.json to include:

{
  "mcpServers": {
    "nocodb": {
      "command": "node",
      "args": ["{working_folder}/dist/start.js"],
      "env": {
        "NOCODB_URL": "https://your-nocodb-instance.com",
        "NOCODB_BASE_ID": "your_base_id_here",
        "NOCODB_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Direct call from CLI

You can directly call the MCP server from the command line:
NOCODB_URL, NOCODB_API_TOKEN, and NOCODB_BASE_ID are required parameters.
NOCODB_URL=https://app.nocodb.com if you are using NocoDB cloud.

npx -y nocodb-mcp-server {NOCODB_URL} {NOCODB_BASE_ID} {NOCODB_API_TOKEN} 

Testing CLI

To run the tests, execute:

npx -y @wong2/mcp-cli npx nocodb-mcp-server {NOCODB_URL} {NOCODB_BASE_ID} {NOCODB_API_TOKEN} 

API Functions

For detailed information about available API functions, please refer to API_FUNCTION.md.

Project Structure

/project-root
  ├── src/            # TypeScript source files
  ├── dist/           # Compiled JavaScript output
  ├── .env            # Environment variable configurations
  ├── package.json    # Project dependencies and scripts
  ├── tsconfig.json   # TypeScript settings

Contribution Guidelines

Contributions are encouraged! Feel free to open issues or submit pull requests.

License

This project is distributed under MIT.