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

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

关于此分支

此代码仓库是 NocoDB-MCP-Server 的 TypeScript 分支。它保留了核心功能，同时提升了可维护性，并增强了与现代 TypeScript 开发实践的兼容性。

托管部署

可通过 Fronteir 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 复制模板并填写相应值。

如何获取 NOCODB_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 云服务，请设置 NOCODB_URL=https://app.nocodb.com。

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

贡献指南

欢迎贡献！您可以随时提交问题或拉取请求。

许可证

此项目基于 MIT 许可证发布。