Nocodb-MCP-Server

🚀 Nocodb MCP 服务器文档

Nocodb MCP 服务器提供了对数据进行操作、管理表结构等功能，支持单条和批量数据处理，方便用户高效地与 Nocodb 进行交互。

🚀 快速开始

下载与安装

1. 从 GitHub 获取代码仓库：

   git clone https://github.com/nocodb/mcp-server.git
   cd mcp-server
   

2. 安装依赖项：

   pip install -r requirements.txt
   

3. 环境变量配置：
   • 设置 NOCODB_BASE_ID 环境变量，例如：

     export NOCODB_BASE_ID=your_base_id
     

启动服务器

python nocodb_mcp_server.py

✨ 主要特性

工具功能

• 数据操作：支持增删改查基本操作。
• 表结构管理：提供获取表结构信息的能力。
• 批量操作：支持单条和批量数据处理。

💻 使用示例

基础用法

# 查询记录示例
print(json.dumps(find_records("customers", {"limit": 10})))

# 插入新记录示例
new_record = {"name": "张三", "email": "zhangsan@example.com"}
print(json.dumps(create_records("customers", [new_record])))

📚 详细文档

API 参考

基础 URL

• 所有请求指向 https://api.nocodb.com/api/v2/。

请求头设置

GET /tables/customers/records HTTP/1.1
Host: api.nocodb.com
xc-token: your_api_token

安全注意事项

认证机制

• 使用 xc-token 请求头进行认证。
• 确保 API 令牌安全，避免泄露。

权限管理

• 通过 Nocodb 的权限系统控制数据访问。
• 定期审查和更新 API 令牌权限。

错误处理

常见错误代码

| 错误码 | 描述 | | ------ | ---- | | 401 | 未授权 | | 403 | 禁止访问 | | 404 | 资源未找到 | | 500 | 内部服务器错误 |

错误响应示例

{
  "error": {
    "code": 401,
    "message": "认证失败"
  }
}

高级功能

日志记录

• 默认日志级别为 ERROR。
• 可通过调整 logging.basicConfig 设置详细日志输出。

批量操作优化

• 使用 bulk_ids 参数实现高效批量处理。
• 确保网络稳定性以避免数据传输中断。

安全最佳实践

1. 最小权限原则：创建具备最少必要权限的 API 令牌。
2. 环境变量管理：避免在代码中硬编码敏感信息，始终使用环境变量。
3. 审计日志：启用 Nocodb 的审计功能以监控数据操作。
4. 定期审查：周期性检查和更新 API 令牌及其权限。

通过遵循这些指南，您可以确保 Nocodb MCP 服务器的安全性和高效运行。