Spotify ACTION
Search
Search for items on Spotify (tracks, albums, artists, playlists, shows, or episodes). See the docs here
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Spotify 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: "spotify-search",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
spotify: { authProvisionId: "apn_xxxxxxx" },
query: "Search Query",
type: ["Search Type"],
},
})
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": "spotify-search",
"configured_props": {
"spotify": { "authProvisionId": "apn_xxxxxxx" },
"query": "Search Query",
"type": ["Search Type"]
}
}'// 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": "spotify",
},
},
},
)
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: "spotify-search",
arguments: {
query: "Search Query",
type: ["Search Type"],
},
})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 | Search query keywords and optional field filters. See the Spotify docs for query syntax Required |
type Search Type | string[] | Type(s) of items to search for Required |
market Market | string | Type to search for a country or enter a custom expression to specify the ISO 3166-1 alpha-2 country code. Optional |
limit Limit | integer | The maximum number of results to return per type. Optional |
offset Offset | integer | The index of the first item to return. Default: 0 (the first object). Use with limit to get the next set of items. Optional |
includeExternal Include External | string | If audio is specified, the response will include any relevant audio content that is hosted externally. 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
- spotify-search
- Version
- 0.0.6
- App
- Spotify
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗