HelpDocs ACTION
Create Article
Create a new article in your HelpDocs knowledge base. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's HelpDocs account once, then configure and run Create Article 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-create-article",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
helpdocs: { authProvisionId: "apn_xxxxxxx" },
title: "Title",
categoryId: "Category ID",
},
})
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-create-article",
"configured_props": {
"helpdocs": { "authProvisionId": "apn_xxxxxxx" },
"title": "Title",
"categoryId": "Category ID"
}
}'// 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-create-article",
arguments: {
title: "Title",
categoryId: "Category ID",
},
})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 |
|---|---|---|
title Title | string | The title of the article Required |
categoryId Category ID | string | The ID of a category Optional Dynamic |
body Body | string | The body of the article Optional |
isPrivate Is Private | boolean | Whether the article is private Optional |
isPublished Is Published | boolean | Whether the article is published Optional |
description Description | string | The description of the article Optional |
shortVersion Short Version | string | The short version of the article Optional |
slug Slug | string | The slug of the article Optional |
tags Tags | string[] | The tags of the article Optional |
multilingual Multilingual | string[] | The language code(s) of the article (e.g. en, fr, etc.) 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-create-article
- Version
- 0.0.2
- App
- HelpDocs
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗