Google Docs ACTION
Create Comment
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- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Google Docs account once, then configure and run Create Comment 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-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 -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"
}
}'// 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": "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",
},
})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 |
|---|---|---|
documentId Document ID | string | 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. Required |
content Comment | string | The plain text of the comment, e.g. Please confirm this figure before we send. Required |
find Find Text | string | 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. Optional |
occurrence Occurrence | string | Which matches of Find Text get a comment: first (default) or all, e.g. first. all creates one separate comment thread per match. Optional |
matchCase Match Case | boolean | Case sensitive search ( true) or not (false), e.g. true. Defaults to false. Optional |
startIndex Start Index | integer | 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. Optional |
endIndex End Index | integer | Character index where the comment's anchor ends, exclusive, e.g. 52. Must be greater than Start Index. Optional |
tabId Tab ID | string | 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. Optional |
assigneeEmail Assignee Email | string | 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. 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-create-comment
- Version
- 0.0.1
- App
- Google Docs
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗