View as Markdown
Linear (API key) icon

Linear (API key) ACTION

Search Documents

Search Linear documents by text query, or list them filtered by project, initiative, or team. When query is provided, performs relevance-ranked full-text search across document titles and content (up to 200 results). When query is omitted, lists documents matching the project/initiative/team filter (up to 20 by default). Results do NOT include the document content field — call Get Document with the returned id or slugId to fetch the full markdown body. Use List Projects for project IDs, List Initiatives for initiative IDs, and Get Teams for team IDs. Leave filter props out of the call entirely to search all accessible documents — do not pass "*" or empty strings. The optional fields prop narrows results to only the keys you need; defaults to a compact set of 8 fields (id, title, slugId, url, createdAt, updatedAt, project, documentContentId). Example: query: "quarterly review" → returns [{id: "...", title: "Q3 Review Notes", url: "...", project: {id: "...", name: "Product"}, documentContentId: "..."}]. Example (filter): projectId: "b75b71a2-..." → returns all documents attached to that project. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Linear (API key) account once, then configure and run Search Documents 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: "linear_app-search-documents",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    linear_app: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    projectId: "Project",
  },
})

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.

Search Documents inputs
Property Type Description
query Query string
Free-text search term for relevance-ranked document search. When provided, searches across document titles and content. When omitted, lists documents by project/initiative/team filter instead. e.g. quarterly review
Optional
projectId Project string
Filter documents by project UUID (e.g. a1b2c3d4-0000-0000-0000-000000000001). Applied only on the filter path (when no query is provided). Leave out entirely to search across all projects — do not pass "*" or an empty string. Use List Projects to find valid project IDs.
Optional
initiativeId Initiative string
Filter documents by initiative UUID. Applied only on the filter path (when no query is provided). Use List Initiatives to find valid initiative IDs. e.g. 5f3c9a10-7b2d-4e61-9c84-2a1d6e0b7f43
Optional
teamId Team string
Filter documents by team UUID. Applied on both the search path (with query) and the filter path. Leave out entirely to search across all teams — do not pass "*" or an empty string. Use Get Teams to find valid team IDs. e.g. 9b2e4f70-1c3a-4d85-a6b9-0e7f2d4c8a15
Optional
includeArchived Include archived boolean
Should archived resources be included? (default: false)
Optional
orderBy Order By string
Sort order for results when using the filter path (no query). Available options: createdAt (default) and updatedAt.
Optional
limit Limit integer
Maximum total number of documents to return. Defaults to 200 when a query is provided, 20 when only filters are used. e.g. 50
Optional
fields Fields string[]
Field names to return for each document. Defaults to a compact set: id, title, slugId, url, createdAt, updatedAt, project, documentContentId. Results never include content — use Get Document with the id or slugId to fetch the full markdown body. e.g. ["id", "title", "url"]
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
linear_app-search-documents
Version
0.0.3
App
Linear (API key)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes