Smartsheet ACTION
Search
Full-text search across everything the account can see, or within a single sheet. This is the fastest way to find a sheet by name: results include whole objects, not just cell contents - each result carries an
objectType of sheet, row, folder, workspace, report, template, attachment, discussion, sight or summaryField, and its objectId is that object's ID. So a result with objectType: "sheet" gives you the sheet ID directly in one call. Prefer this over List Sheets when you know part of a name; use List Sheets to enumerate everything or when you need each sheet's permalink. Searching by a sheet URL does not work - the URL token is not indexed text; pass the URL to Get Sheet instead, which resolves it for you. See the documentation- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Smartsheet account once, then configure and run Search 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: "smartsheet-search",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
smartsheet: { authProvisionId: "apn_xxxxxxx" },
query: "Search Query",
sheetId: "Sheet ID or URL",
},
})
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": "smartsheet-search",
"configured_props": {
"smartsheet": { "authProvisionId": "apn_xxxxxxx" },
"query": "Search Query",
"sheetId": "Sheet ID or URL"
}
}'// 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": "smartsheet",
},
},
},
)
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: "smartsheet-search",
arguments: {
query: "Search Query",
sheetId: "Sheet ID or URL",
},
})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 |
|---|---|---|
query Search Query | string | The text to search for across sheet contents. Required |
sheetId Sheet ID or URL | string | Scope the search to a single sheet. If omitted, searches all sheets. Accepts a numeric sheet ID (e.g. 1234567890123456), or a Smartsheet sheet URL, which is resolved to the ID for you. Use List Sheets to enumerate sheets. 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
- smartsheet-search
- Version
- 0.1.0
- App
- Smartsheet
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗