View as Markdown
Mintlify icon

Mintlify ACTION

Search Documentation

Perform semantic and keyword searches across your documentation. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mintlify account once, then configure and run Search 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: "mintlify-search-documentation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mintlify: { authProvisionId: "apn_xxxxxxx" },
    domain: "Domain",
    query: "Search Query",
  },
})

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 Documentation inputs
Property Type Description
domain Domain string
The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.
Required
query Search Query string
The search query to execute against your documentation content
Required
pageSize Page Size integer
Number of search results to return. Defaults to 10 if not specified
Optional
version Version string
Filter results by documentation version
Optional
language Language string
Filter results by content language
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
mintlify-search-documentation
Version
0.0.1
App
Mintlify
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes