# DocuWriter.ai — Pipedream Connect

> #1 AI Code documentation tools

- API slug: `docuwriter_ai` (use in MCP headers and tool keys)
- Auth: API key (Pipedream-managed)
- Categories: Productivity
- Website: https://docuwriter.ai
- This page (HTML): https://pipedream.com/apps/docuwriter-ai
- Tools: 6 actions · 0 triggers

## Connect via MCP (recommended)

- Endpoint: `https://remote.mcp.pipedream.net/v3`
- Headers: `Authorization: Bearer <token>` · `x-pd-project-id` · `x-pd-environment` · `x-pd-external-user-id` · `x-pd-app-slug: docuwriter_ai`

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "docuwriter_ai",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// e.g. run Generate Code Documentation:
const result = await mcp.callTool({
  name: "docuwriter_ai-generate-documentation",
  arguments: {
    sourceCode: "Source Code",
    filename: "Filename",
  },
})
```

Docs: [MCP guide](https://pipedream.com/docs/connect/mcp/developers.md)

## API proxy

For a DocuWriter.ai endpoint with no pre-built tool, the proxy forwards your request with the connected user's credentials attached.

```bash
# The path segment is the target URL, URL-safe base64 encoded:
# https://app.docuwriter.ai/api/user-info

curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcHAuZG9jdXdyaXRlci5haS9hcGkvdXNlci1pbmZv?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: production"
```

Docs: [API proxy guide](https://pipedream.com/docs/connect/api-proxy.md)

## SDK

```ts
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",
  },
})
```

Docs: [Managed auth guide](https://pipedream.com/docs/connect/managed-auth/quickstart.md) · [Tools guide](https://pipedream.com/docs/connect/components.md)

## Actions (6)

### `docuwriter_ai-generate-documentation` — Generate Code Documentation (Write)

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

Full schema: https://pipedream.com/apps/docuwriter-ai/actions/generate-documentation.md

### `docuwriter_ai-generate-code-optimization` — Generate Code Optimization (Write)

Generate optimization suggestions and improved code for a source file. Consumes 1 Docuwriter credit. Requires workflow timeout of 5+ minutes for large files. See the documentation

Full schema: https://pipedream.com/apps/docuwriter-ai/actions/generate-code-optimization.md

### `docuwriter_ai-generate-tests` — Generate Code Tests (Write)

Generate unit or integration tests for a source code file. Consumes 1 Docuwriter credit. Requires workflow timeout of 5+ minutes for large files. See the documentation

Full schema: https://pipedream.com/apps/docuwriter-ai/actions/generate-tests.md

### `docuwriter_ai-generate-swagger-api` — Generate Swagger/OpenAPI Spec (Write)

Generate an OpenAPI/Swagger specification from source code. Consumes 1 credit per call. Requires workflow timeout of 5+ minutes for large files. See the documentation

Full schema: https://pipedream.com/apps/docuwriter-ai/actions/generate-swagger-api.md

### `docuwriter_ai-generate-uml-diagram` — Generate UML Diagram (Write)

Generate a UML diagram from source code using Mermaid syntax. Consumes 1 Docuwriter credit. Requires workflow timeout of 5+ minutes for large files. See the documentation

Full schema: https://pipedream.com/apps/docuwriter-ai/actions/generate-uml-diagram.md

### `docuwriter_ai-list-generations` — List Generations (Read-only)

List your documentation generations with optional filtering. No Docuwriter credit cost. See the documentation

Full schema: https://pipedream.com/apps/docuwriter-ai/actions/list-generations.md

---

- All apps: https://pipedream.com/apps — index: https://pipedream.com/llms.txt
- Pipedream docs for agents: https://pipedream.com/docs/llms.txt
