View as Markdown
Box icon

Box ACTION

Get Comments

Fetches all comments on a Box file, paginating through every page and returning the full list. Use Add Comment to create a new comment on the file. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

Get Comments inputs
Property Type Description
folderId Parent Folder string
The parent folder of the file. Use 0 for the root folder. Use the List Folders action to retrieve folder IDs.
Optional Dynamic
fileId File ID string
The file to get comments from (e.g. 123456789). Use the List Folder Items action to retrieve file IDs.
Required Dynamic

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-get-comments
Version
0.0.9
App
Box
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes