For macOS:

brew install python3

For Windows: Download from https://python.org (add to PATH during install)

For Linux:

sudo apt-get install python3 python3-pip

Step 2: Check pyairtable

python3 -c "import pyairtable; print(pyairtable.__version__)" 2>/dev/null || echo "NOT_INSTALLED"

If NOT installed:

pip3 install pyairtable

Step 3: Check Airtable API Key

echo "AIRTABLE_API_KEY=${AIRTABLE_API_KEY:+SET}"

If NOT configured, guide the user:

Airtable is not configured yet. Let me help you set it up.

Step 1: Get your Airtable Personal Access Token

Go to https://airtable.com/create/tokens

Click "Create new token"

Name it "Claude Assistant"

Add scopes:

data.records:read (to read records)

data.records:write (optional - to create/update)

schema.bases:read (to see base structure)

Add access to the bases you want

Click "Create token" and copy it (starts with pat...)

Step 2: Set the environment variable
echo 'export AIRTABLE_API_KEY="patXXXXXXXX.XXXXXXX"' >> ~/.zshrc
source ~/.zshrc
Step 3: Restart Claude Code and come back

Then STOP and wait for user to complete setup.

Python Code Patterns

Use these Python patterns for Airtable operations. Always use python3 -c for quick operations.

Initialize

import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])

List All Bases

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
for base in api.bases():
    print(f'{base.id}: {base.name}')
"

Get Base Schema (Tables & Fields)

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
base = api.base('BASE_ID')
for table in base.tables():
    print(f'\n{table.name}:')
    for field in table.schema().fields:
        print(f'  - {field.name} ({field.type})')
"

List Records

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')
for record in table.all():
    print(record['fields'])
"

Filter Records

python3 -c "
import os
from pyairtable import Api
from pyairtable import formulas as F

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')

# Filter by field value
records = table.all(formula=F.match({'Status': 'Active'}))
for r in records:
    print(r['fields'])
"

Search Records

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')

# Search with SEARCH formula
records = table.all(formula=\"SEARCH('SEARCH_TERM', {FieldName})\")
for r in records:
    print(r['fields'])
"

Get Single Record

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')
record = table.get('RECORD_ID')
print(record['fields'])
"

Write Operations (Require Explicit Permission)

Create Record

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')
record = table.create({'Name': 'New Item', 'Status': 'Active'})
print(f\"Created: {record['id']}\")
"

Update Record

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')
table.update('RECORD_ID', {'Status': 'Completed'})
print('Updated')
"

Batch Create

python3 -c "
import os
from pyairtable import Api

api = Api(os.environ['AIRTABLE_API_KEY'])
table = api.table('BASE_ID', 'TABLE_NAME')
records = table.batch_create([
    {'Name': 'Item 1'},
    {'Name': 'Item 2'},
    {'Name': 'Item 3'}
])
print(f'Created {len(records)} records')
"

Privacy Rules (ALWAYS FOLLOW)

See privacy.md for complete rules. Key points:

Read-only by default - Never create, update, or delete without explicit permission
Minimal data - Only fetch what's needed
No token display - NEVER echo or display the API key
Summarize, don't dump - Format responses cleanly

Common Operations

User says...	Action
"Show my bases"	List all bases
"What tables are in [base]?"	Get base schema
"Show records from [table]"	List records
"Find [value] in [table]"	Filter with formula
"Create a record in [table]"	Create (ask permission first)
"Update [record]"	Update (ask permission first)

Displaying Results

Format as clean tables:

Good:

Records in Tasks:
┌──────────────────┬──────────┬────────────┐
│ Name             │ Status   │ Due Date   │
├──────────────────┼──────────┼────────────┤
│ Review proposal  │ Active   │ Jan 20     │
│ Send report      │ Done     │ Jan 18     │
└──────────────────┴──────────┴────────────┘

Bad:

[{"id":"rec123","fields":{"Name":"Review proposal"...

Reference

API Reference - All Python patterns
Privacy Rules - Data handling guidelines

Sources: pyAirtable Documentation, GitHub

airtable

Airtable Client

First: Check Prerequisites

Step 1: Check Python

More from asu-le/claude-plugins

asana

salesforce

hubspot

canvas-lms