🚀 NocoDB MCP Server: Bridging LLMs and Your Database 🚀

Unlock the power of your NocoDB database within your Large Language Model (LLM) applications with the NocoDB Model Context Protocol (MCP) Server. This robust tool provides a seamless interface for LLMs to interact with your data, enabling intelligent data retrieval, manipulation, and creation directly from your AI workflows.

✨ Key Features

Effortless Integration: Connect your LLM applications to NocoDB with a standardized MCP interface.
CRUD Operations: Perform Create, Read, Update, and Delete operations on your NocoDB tables directly from your LLM prompts.
Dynamic Schema Management: Add and delete columns on the fly, adapting your database structure to the needs of your AI.
File Upload Support: Create tables directly from JSON files, streamlining data import and integration.
TypeScript Powered: Built with modern TypeScript for enhanced maintainability, scalability, and type safety.

🛠️ Setup and Configuration

Prerequisites: Ensure you have Node.js and TypeScript installed.
Installation:
```
npm install
npm run build
```
Environment Configuration: Create a .env file with your NocoDB credentials:
```
NOCODB_URL=https://your-nocodb-instance.com
NOCODB_API_TOKEN=your_api_token_here
NOCODB_BASE_ID=your_base_id_here
```
- Finding your NOCODB_BASE_ID: Locate it in your NocoDB instance URL: https://app.nocodb.com/#/{USERNAME}/{NOCODB_BASE_ID}/{TABLE_ID}

🔌 Integration Examples

Claude Desktop Integration

Enhance your Claude Desktop experience by adding the NocoDB MCP Server to your claude_desktop_config.json:

{
  "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"
      }
    }
  }
}

Command-Line Interface (CLI)

Interact with the MCP server directly from your terminal:

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

Testing with MCP-CLI

Verify your setup with the @wong2/mcp-cli:

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

🤖 Example Prompts

Data Manipulation

[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

Schema Modification

[Add Column]
add column with name: Age

update all rows, set Age to 18

[Delete Column]
delete column with name: Age

File Upload

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

JSON file location: example_upload.json

📂 Project Structure

/project-root
  ├── src/            # TypeScript source code
  ├── dist/           # Compiled JavaScript output
  ├── .env            # Environment configuration
  ├── package.json    # Project dependencies
  ├── tsconfig.json   # TypeScript compiler settings