# Create Comment — Google Docs

> Add a comment to a Google Doc, anchored to a piece of text (the highlighted-text comment you get in the Docs UI). Locate the text with Find Text, or pass an explicit Start Index and End Index. Optionally assign the comment to a user with…

- Key: `google_docs-create-comment`
- Type: Action (Write)
- Version: 0.0.1
- App: Google Docs (`google_docs`) — https://pipedream.com/apps/google-docs.md
- This page (HTML): https://pipedream.com/apps/google-docs/actions/create-comment
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/google_docs/actions/create-comment/create-comment.mjs

## Description

Add a comment to a Google Doc, anchored to a piece of text (the highlighted-text comment you get in the Docs UI). Locate the text with **Find Text**, or pass an explicit **Start Index** and **End Index**. Optionally assign the comment to a user with **Assignee Email** so it becomes an action item for them. Use **Find Document** to resolve a document's name to its ID, and **List Comments** to read existing comments and their reply threads. To propose an edit instead of leaving a note, use **Replace Text** with **Suggest Changes**. Returns `{documentId, commentsCreated, commentIds, ranges}`. Example: `find` = `Q3 revenue`, `content` = `Please confirm this figure` returns `{documentId: "1AbC...", commentsCreated: 1, commentIds: ["doco.Z5q_xTWKbB3F"], ranges: [{startIndex: 42, endIndex: 52, tabId: "t.0"}]}`. [See the documentation](https://developers.google.com/workspace/docs/api/reference/rest/v1/documents/batchUpdate)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `documentId` | `string` | Yes | The ID of the Google Doc, e.g. 1AbC.... 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. |
| `content` | `string` | Yes | The plain text of the comment, e.g. Please confirm this figure before we send. |
| `find` | `string` | No | The text to anchor the comment to, matched exactly, e.g. Q3 revenue. The action locates it in the document and comments on each match selected by Occurrence. Leave blank only if you are supplying Start Index and End Index instead. |
| `occurrence` | `string` | No | Which matches of Find Text get a comment: first (default) or all, e.g. first. all creates one separate comment thread per match. |
| `matchCase` | `boolean` | No | Case sensitive search (true) or not (false), e.g. true. Defaults to false. |
| `startIndex` | `integer` | No | Character index where the comment's anchor starts, inclusive, e.g. 42. Use with End Index instead of Find Text. Indices come from Get Document and shift after every edit, so prefer Find Text. |
| `endIndex` | `integer` | No | Character index where the comment's anchor ends, exclusive, e.g. 52. Must be greater than Start Index. |
| `tabId` | `string` | No | For a multi-tab document, restrict the operation to this tab (e.g. t.0). Get tab IDs from List Tabs. Omit to search every tab for Find Text; an explicit Start Index / End Index without a Tab ID applies to the first tab only. |
| `assigneeEmail` | `string` | No | Email address of the user to assign the comment to, e.g. user@example.com. The comment then shows up as an action item for them. Leave blank for an unassigned comment. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "google_docs",
      },
    },
  },
)

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: "google_docs-create-comment",
  arguments: {
    documentId: "Document ID",
    content: "Comment",
  },
})
```

**TypeScript**

```ts
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-create-comment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_docs: { authProvisionId: "apn_xxxxxxx" },
    documentId: "Document ID",
    content: "Comment",
  },
})

console.log(result)
```

**cURL**

```bash
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": "google_docs-create-comment",
    "configured_props": {
      "google_docs": { "authProvisionId": "apn_xxxxxxx" },
      "documentId": "Document ID",
      "content": "Comment"
    }
  }'
```

---

- App: https://pipedream.com/apps/google-docs.md · All apps: https://pipedream.com/apps
