使用说明

项目简介

Airtable Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端,它充当 LLM 应用与 Airtable 数据库之间的桥梁。通过这个服务器,LLM 可以安全、便捷地访问和操作存储在 Airtable 中的数据,从而扩展 LLM 的能力边界,使其能够处理和利用结构化数据。

主要功能点

  • Airtable 数据访问: 提供全面的 Airtable 数据库交互能力,包括:
    • 读取数据: 允许 LLM 查询 Airtable 数据库的结构信息(如数据库列表、表格列表、字段信息等),并读取表格中的记录。
    • 写入数据: 支持 LLM 在 Airtable 数据库中创建、更新和删除记录及表格,实现数据的双向流动。
  • 工具 (Tools) 注册与执行: 内置一系列预定义的工具,例如:
    • 'list_records': 列出表格记录
    • 'search_records': 搜索记录
    • 'list_bases': 列出数据库
    • 'list_tables': 列出表格
    • 'describe_table': 获取表格详情
    • 'get_record': 获取指定记录
    • 'create_record': 创建记录
    • 'update_records': 更新记录
    • 'delete_records': 删除记录
    • 'create_table': 创建表格
    • 'update_table': 更新表格
    • 'create_field': 创建字段
    • 'update_field': 更新字段 这些工具可以通过 MCP 协议被 LLM 客户端调用,从而赋予 LLM 操作 Airtable 数据的能力。
  • 资源 (Resources) 托管: 将 Airtable 数据库的 schema 信息以资源的形式托管在服务器上,LLM 客户端可以按需读取这些资源,了解数据库结构,为后续的数据操作提供上下文信息。

安装步骤

  1. 环境准备: 确保您的开发环境中已安装 Node.js 和 npm (或 yarn)。
  2. 克隆仓库: 在终端中执行以下命令,克隆 Airtable Server 仓库到本地:
    git clone https://github.com/domdomegg/airtable-mcp-server
  3. 进入目录: 克隆完成后,进入项目目录:
    cd airtable-mcp-server
  4. 安装依赖: 运行 npm 或 yarn 命令安装项目依赖:
    npm install
    yarn install

服务器配置

MCP 服务器是为 MCP 客户端(如 Claude 桌面应用)设计的。要将 Airtable Server 集成到 MCP 客户端,您需要在客户端的配置文件中添加服务器配置信息。以下是 Claude 桌面应用 'claude_desktop_config.json' 中配置 Airtable Server 的示例:

{
  "mcpServers": {
    "airtable": {
      "command": "npx",
      "args": [
        "-y",
        "airtable-mcp-server"
      ],
      "env": {
        "AIRTABLE_API_KEY": "YOUR_AIRTABLE_PERSONAL_ACCESS_TOKEN" // 替换为您的 Airtable 个人访问令牌
      }
    }
  }
}

配置参数说明:

  • 'server name': 'airtable' (服务器名称,可以自定义,用于在客户端中标识和引用该服务器)
  • 'command': 'npx' (指定用于启动服务器的命令。'npx' 允许您执行本地安装或全局安装的 npm 包)
  • 'args': 一个字符串数组,包含传递给 'command' 的参数:
    • '-y': (可选,'npx' 的参数,用于自动同意安装 'airtable-mcp-server' 包,避免交互式提示)
    • 'airtable-mcp-server': (指定要执行的 npm 包名称,即 Airtable Server 的入口)
  • 'env': 一个对象,用于设置服务器运行时的环境变量:
    • 'AIRTABLE_API_KEY': 'YOUR_AIRTABLE_PERSONAL_ACCESS_TOKEN' (重要: 请务必替换 'YOUR_AIRTABLE_PERSONAL_ACCESS_TOKEN' 为您在 Airtable 官方网站上创建的个人访问令牌。该令牌需要至少拥有 'schema.bases:read' 和 'data.records:read' 权限,如果需要写入权限,则还需要 'data.records:write' 等权限。请参考 Airtable 官方文档 了解如何创建和管理个人访问令牌。)

基本使用方法

  1. 启动服务器: 当 MCP 客户端(如 Claude 桌面应用)启动并加载配置文件后,通常会自动根据配置信息启动 Airtable Server,无需用户手动运行服务器。
  2. 客户端连接: MCP 客户端会根据配置文件中的 'command' 和 'args' 执行命令,启动 Airtable Server 进程,并建立 MCP 连接。
  3. LLM 工具调用: 在 MCP 客户端中,LLM 可以通过工具调用请求,使用 Airtable Server 提供的各种工具来操作 Airtable 数据。例如,LLM 可以调用 'list_records' 工具来获取指定 Airtable 表格的记录,或者调用 'search_records' 工具来搜索特定信息。
  4. 资源访问: LLM 可以请求读取 Airtable Server 托管的资源,例如表格的 schema 信息,以便更好地理解数据结构,辅助工具调用和数据处理。

注意: 请务必妥善保管您的 Airtable API 密钥,避免泄露,并根据实际需求配置最小必要的权限。

信息

分类

数据库与文件