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