View as Markdown
Grist icon

Grist ACTION

Add Records

Appends new records to a chosen table in Grist. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Grist account once, then configure and run Add Records from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "grist-add-records",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    grist: { authProvisionId: "apn_xxxxxxx" },
    docId: "Document ID",
    tableId: "Table ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Add Records inputs
Property Type Description
docId Document ID string
The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Required
tableId Table ID string
The ID of the table to operate on.
Required Dynamic
records Data Records string[]
The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. [ { "fields": { "pet": "cat", "popularity": 67 } } ].
Required
noParse Do Not Parse boolean
Set to true to prohibit parsing strings according to the column type.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
grist-add-records
Version
0.0.3
App
Grist
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes