Microsoft Excel ACTION
Create Worksheet
Add a new worksheet (tab) to an existing Excel workbook. See the documentation
- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Microsoft Excel account once, then configure and run Create Worksheet 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: "microsoft_excel-create-worksheet",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
microsoft_excel: { authProvisionId: "apn_xxxxxxx" },
folderId: "Folder ID",
sheetId: "Workbook",
},
})
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": "microsoft_excel-create-worksheet",
"configured_props": {
"microsoft_excel": { "authProvisionId": "apn_xxxxxxx" },
"folderId": "Folder ID",
"sheetId": "Workbook"
}
}'// 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": "microsoft_excel",
},
},
},
)
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: "microsoft_excel-create-worksheet",
arguments: {
folderId: "Folder ID",
sheetId: "Workbook",
},
})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 ID | string | Optional. Only narrows the Workbook list below to one folder — it is NOT needed to add the worksheet. If you already have the workbook's item ID (e.g. from Create Workbook), skip this and pass it directly as Workbook. Use List Folder ID Options to find a folder ID (the value field). E.g. 01BYE5RZ6QN3ZWBTRWFNG2FOD7ONP4JLHU Optional Dynamic |
sheetId Workbook | string | The workbook to add the worksheet to — its OneDrive drive-item ID. Pass an ID you already have (e.g. the id returned by Create Workbook); no folder needed. E.g. 01BYE5RZ6QN3ZWBTRWFNG2FOD7ONP4JLHU Required Dynamic |
name Worksheet Name | string | The name for the new worksheet (tab). Must be unique within the workbook and 31 characters or fewer. If omitted, Excel assigns a default name (e.g. Sheet2). E.g. Q3 Results 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
- microsoft_excel-create-worksheet
- Version
- 0.0.1
- App
- Microsoft Excel
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗