HelpDocs ACTION
Search Articles
Search for articles in your HelpDocs knowledge base. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's HelpDocs account once, then configure and run Search Articles 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: "helpdocs-search-articles",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
helpdocs: { authProvisionId: "apn_xxxxxxx" },
query: "Query",
includePrivate: true,
},
})
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": "helpdocs-search-articles",
"configured_props": {
"helpdocs": { "authProvisionId": "apn_xxxxxxx" },
"query": "Query",
"includePrivate": true
}
}'// 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": "helpdocs",
},
},
},
)
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: "helpdocs-search-articles",
arguments: {
query: "Query",
includePrivate: true,
},
})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 Query | string | The search term string you'd like results for Required |
includePrivate Include Private | boolean | Include articles with a private status in the results Optional |
includeDraft Include Draft | boolean | Include articles with a draft status in the results Optional |
languageCode Language Code | string | If you have multilingual enabled, this will be the ISO language code you're trying to search in (e.g. fr, en, etc.). If you don't send this we'll search in your account's default language. Optional |
limit Limit | integer | How many results you'd like to receive 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
- helpdocs-search-articles
- Version
- 0.0.2
- App
- HelpDocs
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗