View as Markdown
Google Docs icon

Google Docs ACTION

List Suggestions

List the open suggestions (tracked changes made in Suggesting mode) in a Google Doc, with each suggestion's ID, what it changes, and where. Use this to review proposed edits, or to get the IDs Resolve Suggestions needs to accept or reject them. Use Find Document to resolve a document's name to its ID. Returns {documentId, suggestionCount, suggestions: [{suggestionId, tabId, startIndex, endIndex, types, insertedText, deletedText}]} in document order. types names what the suggestion changes (e.g. insertion, deletion, textStyle, paragraphStyle, bullet, tableCellStyle). insertedText / deletedText are lists with one entry per place the suggestion adds or removes text, and appear only when it does. startIndex / endIndex span everything the suggestion touches. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Docs account once, then configure and run List Suggestions 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: "google_docs-list-suggestions",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_docs: { authProvisionId: "apn_xxxxxxx" },
    documentId: "Document ID",
    tabId: "Tab 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.

List Suggestions inputs
Property Type Description
documentId Document ID string
The ID of the Google Doc. This is the long string in the document's URL: https://docs.google.com/document/d/{DOCUMENT_ID}/edit. Use Find Document to resolve a document's name to its ID.
Required
tabId Tab ID string
For a multi-tab document, list only the suggestions in this tab (e.g. t.0). Get tab IDs from List Tabs. Omit to list suggestions in every tab.
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
google_docs-list-suggestions
Version
0.0.1
App
Google Docs
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes