Nocodb MCP Server

🚀 Nocodb MCP 服务器

Nocodb MCP 服务器使用户能够通过模型上下文协议 (MCP) 无缝地与 Nocodb 数据库进行交互，支持对 Nocodb 表执行 CRUD（创建、读取、更新、删除）操作，为数据库操作提供了便捷的解决方案。

🚀 快速开始

确保安装了 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/maty9c5xkmf401 其中，maty9c5xkmf401 就是 NOCODB_BASE_ID。

✨ 主要特性

• 通过模型上下文协议 (MCP) 无缝与 Nocodb 数据库进行交互。
• 支持对 Nocodb 表执行 CRUD（创建、读取、更新、删除）操作。

💻 使用示例

基础用法

以下是一些示例提示，展示了如何使用 Nocodb MCP 服务器进行不同的操作：

[获取记录]
从 nocodb 获取数据，表：Shinobi

[创建记录]
添加新行，名称为：sasuke-2
添加其他行，名称为：naruto-2

[更新记录]
更新所有行，移除后缀 -

[删除记录]
删除名称为 naruto 的所有行

[添加列]
添加名为：Age 的列

更新所有行，将 Age 设置为 18

[删除列]
删除名为：Age 的列

高级用法 - 上传文件

[创建表]
从 json 文件
放到 nocodb 数据库中
表名是 TableShinobi

json 文件位置在：example_upload.json

高级用法 - 批量创建记录和批量删除记录

📚 详细文档

集成

VS Code 插件

为了提高开发效率，可以安装 vscode-nocodb 插件。该插件支持以下功能：

• 数据库资源管理
• 表结构查看
• 数据预览
• 快速访问文档

Postman 集成

为了方便 API 测试，推荐使用 Postman。你可以在其中创建 Nocodb 的专用工作区，并通过以下步骤快速上手：

1. 添加新请求
2. 设置合适的请求头和参数
3. 发送并查看响应结果

项目结构

- config/：包含服务器配置文件
- routes/：定义 API 路由
- controllers/：处理具体业务逻辑的控制器
- models/：数据库模型定义
- public/：静态资源文件

🔧 技术细节

这个仓库是一个基于 TypeScript 的分支版本，继承自 Nocodb-MCP-Server。它保留了核心功能，同时提升了可维护性和与现代 TypeScript 开发实践的兼容性。

📄 许可证

该项目以 MIT 许可证分发。

📚 文献引用

如果这个项目对你有帮助，欢迎在你的项目中引用：

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