MCP 服务器

Nocodb MCP Server

granthooks

开发者工具

访问服务器

README

Nocodb MCP 服务器

此 MCP 服务器提供通过模型上下文协议与 Nocodb 数据库交互的工具，为 Nocodb 表提供 CRUD 操作（创建、读取、更新、删除）。

安装

安装所需的依赖项：

pip install -r requirements.txt

确保您已安装 MCP Python SDK（应与上述依赖项一起安装）：

pip install "mcp[cli]"

配置

此 MCP 服务器需要三个环境变量：

NOCODB_URL: 您的 Nocodb 实例的基本 URL（例如，https://example.com/ncdb）
NOCODB_API_TOKEN: 用于与 Nocodb 身份验证的 API 令牌
NOCODB_BASE_ID: 您的 Nocodb 数据库的基本 ID

您可以从您的 Nocodb 实例获取 API 令牌，方法是：

登录到您的 Nocodb 实例
转到“帐户设置”>“API 令牌”
创建具有适当权限的新令牌

基本 ID 可以在您的 Nocodb 仪表板的 URL 中找到：https://your-nocodb.com/dashboard/#/nc/base/YOUR_BASE_ID/table/...

用法

与 Claude Desktop 一起使用

要与 Claude Desktop 集成，请将以下配置添加到 claude_desktop_config.json：

{
  "mcpServers": {
    "nocodb": {
      "command": "python",
      "args": [
        "path/to/nocodb_mcp_server.py"
      ],
      "env": {
        "NOCODB_URL": "https://your-nocodb-instance.com",
        "NOCODB_API_TOKEN": "your_api_token_here",
        "NOCODB_BASE_ID": "your_base_id_here"
      }
    }
  }
}

或者使用 MCP CLI 安装（推荐）：

# 基本安装
mcp install nocodb_mcp_server.py

# 使用环境变量
mcp install nocodb_mcp_server.py -v NOCODB_URL=https://your-nocodb-instance.com -v NOCODB_API_TOKEN=your_token -v NOCODB_BASE_ID=your_base_id

# 或者使用 .env 文件
mcp install nocodb_mcp_server.py -f .env

作为独立服务器运行

# 安装依赖项
pip install -r requirements.txt

# 直接运行服务器
python nocodb_mcp_server.py

# 或者使用 MCP CLI
mcp run nocodb_mcp_server.py

开发模式

用于使用 MCP Inspector 进行测试和调试：

# 在开发模式下运行
mcp dev nocodb_mcp_server.py

与 Windows 上的 Cursor 一起使用

对于 Windows 上的 Cursor，请在您的 mcp.json 配置文件中使用以下语法：

{
  "mcpServers": {
    "nocodb": {
      "command": "C:\\Path\\To\\Your\\Python\\Executable",
      "args": [
        "C:\\Path\\To\\Your\\nocodb_mcp_server.py"
      ],
      "env": {
        "NOCODB_URL": "http://localhost:8080",
        "NOCODB_API_TOKEN": "your_api_token_here",
        "NOCODB_BASE_ID": "your_base_id_here"
      }
    }
  }
}

可用工具

该服务器提供以下工具：

1. retrieve_records

从 Nocodb 表中检索一个或多个记录。

参数：

table_name: 要查询的表的名称
row_id（可选）：要检索单个记录的特定行 ID
filters（可选）：Nocodb 格式的筛选条件
limit（可选）：要返回的最大记录数（默认值：10）
offset（可选）：要跳过的记录数，用于分页（默认值：0）
sort（可选）：要排序的列
fields（可选）：要包含的字段的逗号分隔列表

示例：

# 获取表中的所有记录（限制为 10）
retrieve_records(table_name="customers")

# 按 ID 获取特定记录
retrieve_records(table_name="customers", row_id="123")

# 使用条件筛选记录
retrieve_records(
    table_name="customers", 
    filters="(age,gt,30)~and(status,eq,active)"
)

2. create_records

在 Nocodb 表中创建一个或多个记录。

参数：

table_name: 要插入的表的名称
data: 包含 column:value 对的字典，或用于批量创建的此类字典的列表
bulk（可选）：设置为 True 以进行批量创建

示例：

# 创建单个记录
create_records(
    table_name="customers",
    data={"name": "John Doe", "email": "john@example.com", "age": 35}
)

# 批量创建多个记录
create_records(
    table_name="customers",
    data=[
        {"name": "John Doe", "email": "john@example.com", "age": 35},
        {"name": "Jane Smith", "email": "jane@example.com", "age": 28}
    ],
    bulk=True
)

3. update_records

更新 Nocodb 表中的一个或多个记录。

参数：

table_name: 要更新的表的名称
row_id: 要更新的记录的 ID（更新单个记录时必需）
data: 包含要更新的 column:value 对的字典
bulk（可选）：设置为 True 以进行批量更新
bulk_ids（可选）：当 bulk=True 时要更新的记录 ID 列表

示例：

# 按 ID 更新单个记录
update_records(
    table_name="customers",
    row_id="123",
    data={"name": "John Smith", "status": "inactive"}
)

# 通过 ID 批量更新多个记录
update_records(
    table_name="customers",
    data={"status": "inactive"},  # 相同的更新应用于所有记录
    bulk=True,
    bulk_ids=["123", "456", "789"]
)

4. delete_records

从 Nocodb 表中删除一个或多个记录。

参数：

table_name: 要从中删除的表的名称
row_id: 要删除的记录的 ID（删除单个记录时必需）
bulk（可选）：设置为 True 以进行批量删除
bulk_ids（可选）：当 bulk=True 时要删除的记录 ID 列表

示例：

# 按 ID 删除单个记录
delete_records(
    table_name="customers",
    row_id="123"
)

# 通过 ID 批量删除多个记录
delete_records(
    table_name="customers",
    bulk=True,
    bulk_ids=["123", "456", "789"]
)