View as Markdown
Xata icon

Xata ACTION

List Branches

List branches of the specified database. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Xata account once, then configure and run List Branches 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: "xata-list-branches",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    xata: { authProvisionId: "apn_xxxxxxx" },
    endpoint: "HTTP Endpoint",
    workspace: "Workspace ID",
  },
})

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.

List Branches inputs
Property Type Description
endpoint HTTP Endpoint string
The endpoint of your database, i.e.: https://my-workspace-123456.us-east-1.xata.sh. You can find your workspace domain by navigating to the Configuration tab in the Xata Web UI
Required
workspace Workspace ID string
ID of your workspace
Required Dynamic
database Database Name string
Name of the database. Must be NON POSTGRES ENABLED.
Required Dynamic

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
xata-list-branches
Version
0.0.2
App
Xata
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes