Tableau ACTION
List Workbooks
Returns a list of the workbooks on the specified site. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Tableau account once, then configure and run List Workbooks 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: "tableau-list-workbooks",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
tableau: { authProvisionId: "apn_xxxxxxx" },
siteId: "Site ID",
filter: "Filter",
},
})
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": "tableau-list-workbooks",
"configured_props": {
"tableau": { "authProvisionId": "apn_xxxxxxx" },
"siteId": "Site ID",
"filter": "Filter"
}
}'// 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": "tableau",
},
},
},
)
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: "tableau-list-workbooks",
arguments: {
siteId: "Site ID",
filter: "Filter",
},
})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 |
|---|---|---|
siteId Site ID | string | The ID of the site to list workbooks for. Can use the List Sites action to get a list of sites. Required Dynamic |
filter Filter | string | An expression that lets you specify a subset of workbooks to return. You can filter on predefined fields such as name, tags, and createdAt. You can include multiple filter expressions. For more information, see Filtering and Sorting. Optional |
sort Sort | string | An expression that lets you specify the order in which workbook information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting. Optional |
field Field | string | An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as all or default, and you can specify individual fields for the workbooks or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the REST API. Optional |
pageSize Page Size | integer | The number of workbooks to return per page. The default is 100. Maximum is 1000. Optional |
pageNumber Page Number | integer | The page number to return. The default is 1. 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
- tableau-list-workbooks
- Version
- 0.0.2
- App
- Tableau
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗