View as Markdown
Databricks icon

Databricks ACTION

Scan Vector Search Index

Scans a vector search index and returns entries after the given primary key. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Databricks account once, then configure and run Scan Vector Search Index 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: "databricks-scan-vector-search-index",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    databricks: { authProvisionId: "apn_xxxxxxx" },
    endpointName: "Endpoint Name",
    indexName: "Index Name",
  },
})

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.

Scan Vector Search Index inputs
Property Type Description
endpointName Endpoint Name string
The name of the vector search endpoint
Required Dynamic
indexName Index Name string
The name of the vector search index
Required Dynamic
lastPrimaryKey Last Primary Key string
Primary key of the last entry returned in the previous scan. Leave empty to start from the beginning.
Optional
numResults Number of Results integer
Number of results to return (defaults to 10).
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
databricks-scan-vector-search-index
Version
0.0.5
App
Databricks
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes