Akeneo ACTION
Search Products
Search products from Akeneo. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Akeneo account once, then configure and run Search Products 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: "akeneo-search-products",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
akeneo: { authProvisionId: "apn_xxxxxxx" },
search: "Search",
scope: "Scope",
},
})
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": "akeneo-search-products",
"configured_props": {
"akeneo": { "authProvisionId": "apn_xxxxxxx" },
"search": "Search",
"scope": "Scope"
}
}'// 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": "akeneo",
},
},
},
)
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: "akeneo-search-products",
arguments: {
search: "Search",
scope: "Scope",
},
})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 |
|---|---|---|
search Search | string | Filter products, for more details see the Filters section Optional |
scope Scope | string | Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section Optional Dynamic |
locales Locale | string | Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section Optional Dynamic |
attributes Attributes | string | Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section Optional Dynamic |
convertMeasurements Convert Measurements | boolean | Convert values of measurement attributes to the unit configured in the channel provided by the parameter "scope". Therefore, this parameter requires the "scope" parameter to be provided. Optional |
withCount With Count | boolean | Return the count of items in the response. Be careful: on large catalogs, enabling counts can significantly impact performance. Optional |
withAttributeOptions With Attribute Options | boolean | Return labels of attribute options in the response. See the linked_data format section for more details. Optional |
withAssetShareLinks With Asset Share Links | boolean | Return asset collection share link urls in the response. See the linked_data format section for more details. Optional |
withQualityScores With Quality Scores | boolean | Return product quality scores in the response Optional |
withCompletenesses With Completeness | boolean | Return product completenesses in the response Optional |
page Page | integer | The page number to return Optional |
limit Limit | integer | The number of items to return per page 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
- akeneo-search-products
- Version
- 0.0.3
- App
- Akeneo
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗