Box ACTION
List Folders
Lists the subfolders directly inside a Box folder. Use
0 for the root folder. Returns one page of results (default 100, max 1000). Use List Folder Items instead to also include files and web links. See the documentation.- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Box account once, then configure and run List Folders 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-list-folders",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
box: { authProvisionId: "apn_xxxxxxx" },
folderId: "Folder",
fields: ["Fields"],
},
})
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": "box-list-folders",
"configured_props": {
"box": { "authProvisionId": "apn_xxxxxxx" },
"folderId": "Folder",
"fields": ["Fields"]
}
}'// 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": "box",
},
},
},
)
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: "box-list-folders",
arguments: {
folderId: "Folder",
fields: ["Fields"],
},
})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 |
|---|---|---|
folderId Folder | string | The folder to list subfolders from. Use 0 for the root folder. Required Dynamic |
fields Fields | string[] | A comma-separated list of attributes to include in the response (e.g. id,type,name,size,created_at). See available fields. Optional |
sort Sort | string | Defines the attribute by which items are sorted. Valid values: id, name, date, size (e.g. name). Not supported for the root folder (0) — Box does not allow sorting root-folder results with marker-based pagination. Optional |
direction Direction | string | The direction to sort results in. Valid values: ASC (ascending) or DESC (descending) (e.g. ASC). Optional |
limit Limit | integer | The maximum number of folders to return per page (max 1000) Optional |
marker Marker | string | The position marker at which to begin returning results. Pass the next_marker value returned by a previous run of this action to continue listing beyond the first page, e.g. JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii. 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
- box-list-folders
- Version
- 0.0.2
- App
- Box
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗