Databricks ACTION
Create Vector Search Index
Creates a new vector search index in Databricks. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Databricks account once, then configure and run Create 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-create-vector-search-index",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
databricks: { authProvisionId: "apn_xxxxxxx" },
name: "Index Name",
endpointName: "Endpoint Name",
},
})
console.log(result)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": "databricks-create-vector-search-index",
"configured_props": {
"databricks": { "authProvisionId": "apn_xxxxxxx" },
"name": "Index Name",
"endpointName": "Endpoint Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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": "databricks",
},
},
},
)
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: "databricks-create-vector-search-index",
arguments: {
name: "Index Name",
endpointName: "Endpoint Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
name Index Name | string | A unique name for the index (e.g., main_catalog.docs.en_wiki_index). Required |
endpointName Endpoint Name | string | The name of the vector search endpoint Required Dynamic |
indexType Index Type | string | Type of index ( DELTA_SYNC or DIRECT_ACCESS). Required |
primaryKey Primary Key | string | The primary key column for the index. Required |
sourceTable Source Table | string | The Delta table backing the index (required for DELTA_SYNC). Optional |
columnsToSync Columns to Sync | string[] | List of columns to sync from the source Delta table. Example: ["id", "text"] (required for DELTA_SYNC). Optional |
embeddingSourceColumns Embedding Source Columns | string[] | List of embedding source column configs. Each entry is a JSON object string like { "embedding_model_endpoint_name": "e5-small-v2", "name": "text" }.Provide when Databricks computes embeddings (DELTA_SYNC). Optional |
schemaJson Schema JSON | string | The schema of the index in JSON format. Example: { "columns": [{ "name": "id", "type": "string" }, { "name": "text_vector", "type": "array<double>" }] }. Required for DIRECT_ACCESS indexes. Optional |
pipelineType Pipeline Type | string | Pipeline type for syncing (default: TRIGGERED). 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-create-vector-search-index
- Version
- 0.0.3
- App
- Databricks
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗