# List Document Comments — Linear (API key)

> List the comments on a Linear document. Use Search Documents to find the document ID. For comments on issues use List Comments instead. Returns comment objects with id, body, createdAt, user (author), parent (the comment being replied to…

- Key: `linear_app-list-document-comments`
- Type: Action (Read-only)
- Version: 0.0.1
- App: Linear (API key) (`linear_app`) — https://pipedream.com/apps/linear-app.md
- This page (HTML): https://pipedream.com/apps/linear-app/actions/list-document-comments
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/linear_app/actions/list-document-comments/list-document-comments.mjs

## Description

List the comments on a Linear document. Use **Search Documents** to find the document ID. For comments on issues use **List Comments** instead. Returns comment objects with `id`, `body`, `createdAt`, `user` (author), `parent` (the comment being replied to, or null), `resolvedAt` (null if unresolved), and `quotedText` (for inline comments, the document text the comment is anchored to; null otherwise). Supports pagination via `first`/`after`. Example: `documentId: "10b5bc2940c7"`, `first: 10` → returns `{nodes: [{id: "cmt_xyz", body: "Can we tighten the timeline?", createdAt: "2024-01-15T10:00:00Z", parent: null, resolvedAt: null, user: {id: "usr_1", name: "Ada"}}], pageInfo: {endCursor: "...", hasNextPage: false}}`. [See the documentation](https://studio.apollographql.com/public/Linear-API/variant/current/schema/reference/objects/Document?query=comments)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `documentId` | `string` | Yes | The document to list comments for: its UUID or slugId (the short code at the end of the document URL, e.g. 10b5bc2940c7). Use Search Documents to find document IDs. |
| `orderBy` | `string` | No | By which field should the pagination order by. Available options are createdAt (default) and updatedAt. |
| `first` | `integer` | No | Maximum number of records to return (min 1, max 100). Example: 10. |
| `after` | `string` | No | Pagination cursor from a previous response's pageInfo.endCursor to fetch the next page. Example: 4919b279-3121-4609-880e-a70c11deca5a. |
| `includeArchived` | `boolean` | No | Whether to include archived comments in the results (default: false). Example: true. |
| `fields` | `string[]` | No | Optional list of field names to include in each returned comment object. When omitted, the full comment payload is returned. Pass a subset to reduce response size, e.g. ["id", "body", "createdAt"]. |

## Run it

**MCP**

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

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: "linear_app-list-document-comments",
  arguments: {
    documentId: "Document ID",
    orderBy: "Order By",
  },
})
```

**TypeScript**

```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: "linear_app-list-document-comments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    linear_app: { authProvisionId: "apn_xxxxxxx" },
    documentId: "Document ID",
    orderBy: "Order By",
  },
})

console.log(result)
```

**cURL**

```bash
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": "linear_app-list-document-comments",
    "configured_props": {
      "linear_app": { "authProvisionId": "apn_xxxxxxx" },
      "documentId": "Document ID",
      "orderBy": "Order By"
    }
  }'
```

---

- App: https://pipedream.com/apps/linear-app.md · All apps: https://pipedream.com/apps
