Grist ACTION
Add Or Update Records
Add records in a specified table or updates existing matching records. See the documentation
- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Grist account once, then configure and run Add Or Update 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-update-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)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "grist-add-update-records",
"configured_props": {
"grist": { "authProvisionId": "apn_xxxxxxx" },
"docId": "Document ID",
"tableId": "Table ID"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "grist",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "grist-add-update-records",
arguments: {
docId: "Document ID",
tableId: "Table ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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 |
noParse Do Not Parse | boolean | Set to true to prohibit parsing strings according to the column type. Optional |
onMany On Many | string | Which records to update if multiple records are found to match. Optional |
noAdd No Add | boolean | Set to true to prohibit adding records. Optional |
noUpdate No Update | boolean | Set to true to prohibit updating records. Optional |
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 } } ]. Instead of an id, a require object is provided, with the same structure as fields. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in require. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in require and fields, with fields taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. [ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ] Required |
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-update-records
- Version
- 0.0.3
- App
- Grist
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗