View as Markdown
Box icon

Box ACTION

Add Comment

Adds a comment to a Box file. To mention a user, include @[user_id:name] in the message and Box will notify them by email. Use Get Comments to read existing comments on a file. See the documentation.
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Box account once, then configure and run Add 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: "box-add-comment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    box: { authProvisionId: "apn_xxxxxxx" },
    folderId: "Parent Folder",
    fileId: "File",
  },
})

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 Comment inputs
Property Type Description
folderId Parent Folder string
The parent folder of the file to comment on. Use 0 for the root folder. Use the List Folders action to retrieve folder IDs.
Optional Dynamic
fileId File string
The file to add a comment to (e.g. 123456789). Use the List Folder Items action to retrieve file IDs.
Required Dynamic
message Message string
The text of the comment. To mention a user, include @[user_id:name] in the text (e.g. @[1234:John] Review completed!) and Box will send them an email notification.
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
box-add-comment
Version
0.0.2
App
Box
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes