View as Markdown
DocuWriter.ai icon

DocuWriter.ai ACTION

Generate Code Documentation

Generate AI-powered documentation for a source code file. Consumes 1 Docuwriter credit. Requires workflow timeout of 5+ minutes for large files. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's DocuWriter.ai account once, then configure and run Generate Code Documentation 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: "docuwriter_ai-generate-documentation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    docuwriter_ai: { authProvisionId: "apn_xxxxxxx" },
    sourceCode: "Source Code",
    filename: "Filename",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Generate Code Documentation inputs
Property Type Description
sourceCode Source Code string
The raw source code to process
Required
filename Filename string
The filename for context (e.g., UserService.php)
Required
outputLanguage Output Language string
Language for generated docs (e.g., English, Spanish, German)
Optional
documentationType Documentation Type string
Documentation style to generate (e.g., General Documentation, API Reference, Inline Comments)
Optional
additionalInstructions Additional Instructions string
Optional extra instructions for the AI generation
Optional
name Name string
Custom title for this generation (max 255 chars).
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
docuwriter_ai-generate-documentation
Version
0.0.3
App
DocuWriter.ai
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes