MCP HubMCP Hub
domdomegg

airtable-mcp-server

by: domdomegg

πŸ—‚οΈπŸ€– Airtable Model Context Protocol Server, for allowing AI systems to interact with your Airtable bases

111created 12/12/2024
Visit
Airtable
AI

πŸ“ŒOverview

Purpose: The airtable-mcp-server framework provides a Model Context Protocol server that facilitates both read and write access to Airtable databases, designed for interaction with large language models (LLMs).

Overview: This server enables LLMs to analyze the schema of Airtable databases and perform operations such as creating, reading, updating, and deleting records. It supports various functionalities in an intuitive manner, allowing developers to leverage Airtable's features within their applications.

Key Features:

  • Data Access: Allows users to list records, search for specific data, and retrieve detailed information about tables and bases. This facilitates easy data management and exploration within Airtable.

  • Record Manipulation: Enables record creation, deletion, and updates, providing comprehensive control over database entries directly through the server.

  • Schema Discovery: Automatically retrieves and exposes schema information for Airtable bases and tables, making it easier for developers to work with data structures and understand the organization of their databases.


airtable-mcp-server

A Model Context Protocol server that provides read and write access to Airtable databases. This server enables LLMs to inspect database schemas, then read and write records.

Usage

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your claude_desktop_config.json:

{
  "mcpServers": {
    "airtable": {
      "command": "npx",
      "args": [
        "-y",
        "airtable-mcp-server"
      ],
      "env": {
        "AIRTABLE_API_KEY": "pat123.abc123"
      }
    }
  }
}

Replace pat123.abc123 with your Airtable personal access token. Your token should have at least schema.bases:read and data.records:read, and optionally the corresponding write permissions.

Components

Tools

  • list_records
    Lists records from a specified Airtable table
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table to query
    • maxRecords (number, optional): Maximum number of records to return. Defaults to 100.
    • filterByFormula (string, optional): Airtable formula to filter records
  • search_records
    Search for records containing specific text
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table to query
    • searchTerm (string, required): Text to search for in records
    • fieldIds (array, optional): Specific field IDs to search in. If not provided, searches all text-based fields.
    • maxRecords (number, optional): Maximum number of records to return. Defaults to 100.
  • list_bases
    Lists all accessible Airtable bases
    No input parameters required
    Returns base ID, name, and permission level

  • list_tables
    Lists all tables in a specific base
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • detailLevel (string, optional): The amount of detail to get about the tables (tableIdentifiersOnly, identifiersOnly, or full)
      Returns table ID, name, description, fields, and views (to the given detailLevel)
  • describe_table
    Gets detailed information about a specific table
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table to describe
    • detailLevel (string, optional): The amount of detail to get about the table (tableIdentifiersOnly, identifiersOnly, or full)
      Returns the same format as list_tables but for a single table
  • get_record
    Gets a specific record by ID
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • recordId (string, required): The ID of the record to retrieve
  • create_record
    Creates a new record in a table
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • fields (object, required): The fields and values for the new record
  • update_records
    Updates one or more records in a table
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • records (array, required): Array of objects containing record ID and fields to update
  • delete_records
    Deletes one or more records from a table
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • recordIds (array, required): Array of record IDs to delete
  • create_table
    Creates a new table in a base
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • name (string, required): Name of the new table
    • description (string, optional): Description of the table
    • fields (array, required): Array of field definitions (name, type, description, options)
  • update_table
    Updates a table's name or description
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • name (string, optional): New name for the table
    • description (string, optional): New description for the table
  • create_field
    Creates a new field in a table
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • name (string, required): Name of the new field
    • type (string, required): Type of the field
    • description (string, optional): Description of the field
    • options (object, optional): Field-specific options
  • update_field
    Updates a field's name or description
    Input parameters:

    • baseId (string, required): The ID of the Airtable base
    • tableId (string, required): The ID of the table
    • fieldId (string, required): The ID of the field
    • name (string, optional): New name for the field
    • description (string, optional): New description for the field

Resources

The server provides schema information for Airtable bases and tables:

  • Table Schemas (airtable://<baseId>/<tableId>/schema)
    JSON schema information for each table, including:
    • Base id and table id
    • Table name and description
    • Primary field ID
    • Field definitions (ID, name, type, description, options)
    • View definitions (ID, name, type)
      This information is automatically discovered from Airtable's metadata API.

Contributing

Pull requests are welcomed on GitHub! To get started:

  1. Install Git and Node.js
  2. Clone the repository
  3. Install dependencies with npm install
  4. Run npm run test to run tests
  5. Build with npm run build
    • Use npm run build:watch to automatically build after editing source files.

Releases

Versions follow the semantic versioning specification.

To release:

  1. Use npm version <major | minor | patch> to bump the version
  2. Run git push --follow-tags to push with tags
  3. Wait for GitHub Actions to publish to the NPM registry.