NocoDB MCP服务器

NocoDB MCP服务器通过模型上下文协议(MCP)实现与NocoDB数据库的无缝交互,支持通过自然语言命令执行CRUD操作。

  • by edwinbernadus
  • JavaScript
  • 本地部署
  • 76 星标
  • 更新于
在 GitHub 查看 edwinbernadus/nocodb-mcp-server

使用说明

Nocodb MCP服务器

介绍

NocoDB MCP服务器使用模型上下文协议(MCP)实现与NocoDB数据库的无缝交互。该服务器使通过自然语言命令对NocoDB表执行CRUD(创建、读取、更新、删除)操作变得容易。

示例提示

[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

示例提示-上传文件

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

JSON位置文件位于: example_upload.json

示例提示-批量创建记录和批量删除记录

关于这个叉子

这个存储库是基于TypeScript的 NocoDB MCP服务器它保留了核心功能,同时提高了可维护性和与现代TypeScript开发实践的兼容性。

托管部署

托管部署可在 Frontier AI.

设置

确保已安装Node.js和TypeScript,然后执行:

npm install
npm run build

配置

在中定义所需的环境变量 .env 文件:

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

提示: 您可以从以下位置复制模板 env.example 并填写你的价值观。

如何获取NOCODEB_BASE_ID

找到你的 NOCODB_BASE_ID,检查您的Nocodb实例的URL。
例如: https://app.nocodb.com/#/wi6evls6/pqmob3ammcknma5/maty9c5xkmf4012
在此URL格式中:

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

与Claude Desktop集成

修改 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"
      }
    }
  }
}

CLI直接呼叫

您可以直接从命令行调用MCP服务器:
NOCODB_URL、NOCODB_API_TOKEN和NOCODB_BASE_ID是必需的参数。
NOCODB_URL=https://app.nocodb.com 如果您正在使用NocoDB云。

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

测试CLI

要运行测试,请执行:

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

API函数

有关可用API函数的详细信息,请参阅 API_注释.md.

项目结构

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

贡献指南

鼓励捐款!请随时打开问题或提交pull请求。

许可证

该项目由麻省理工学院负责分发。