Prisma

Learn how to use Prisma with Composio

Overview

SLUG: PRISMA

Description

Prisma Data Platform provides database tools including Accelerate (global database cache), Optimize (AI-driven query analysis), and Prisma Postgres (managed PostgreSQL). Manage workspaces, projects, environments, and API keys programmatically.

Authentication Details

token
stringRequired

Connecting to Prisma

Create an auth config

Use the dashboard to create an auth config for the Prisma toolkit. This allows you to connect multiple Prisma accounts to Composio for agents to use.

1

Select App

Navigate to the Prisma toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using Bearer Token

1from composio import Composio
2from composio.types import auth_scheme
3
4# Auth config ID created above
5prisma_auth_config_id = "ac_YOUR_PRISMA_CONFIG_ID"
6
7# UUID from database/application
8user_id = "0000-0000-0000"
9
10composio = Composio()
11
12
13def authenticate_toolkit(user_id: str, auth_config_id: str):
14 # Replace this with a method to retrieve the Bearer Token from the user.
15 bearer_token = input("[!] Enter bearer token")
16 connection_request = composio.connected_accounts.initiate(
17 user_id=user_id,
18 auth_config_id=auth_config_id,
19 config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
20 )
21 print(f"Successfully connected Prisma for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, prisma_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Prisma toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PRISMA"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Database Connection

Description

Create new api key connection for database access. creates connection string with embedded credentials for application database access. returns complete connection details ready for immediate use.

Action Parameters

databaseId
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Project Database

Description

Create new postgres database in an existing prisma project. creates database in specified region with connection strings and api keys. returns complete database details ready for immediate use.

Action Parameters

isDefault
boolean
name
stringRequired
projectId
stringRequired
region
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Prisma Project

Description

Create new prisma project with managed postgres database. creates project in authenticated user's workspace with postgres database in specified region. returns complete project details including connection strings and api keys.

Action Parameters

name
stringRequired
region
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Execute SQL Command

Description

Execute sql commands that modify database data or structure. runs insert, update, delete, create table, and other data modification commands safely through postgresql driver with parameterized query support.

Action Parameters

command
stringRequired
connectionString
stringRequired
parameters
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Execute SQL Query

Description

Execute sql select queries against prisma databases. runs read-only queries safely through postgresql driver with automatic type mapping. perfect for data analysis, schema inspection, and reporting operations.

Action Parameters

connectionString
stringRequired
parameters
array
query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prisma Database

Description

Retrieve specific prisma database by id. returns database details including status, project context, and regional deployment. use for database monitoring, validation, and administrative operations.

Action Parameters

databaseId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Prisma Project

Description

Retrieve specific prisma project by id. returns project details including name, creation timestamp, and workspace information. use for project detail views, validation, and administrative operations.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Inspect Database Schema

Description

Inspect database schema structure and table information. returns comprehensive schema details including tables, columns, data types, constraints, and relationships. essential for understanding database structure before executing queries.

Action Parameters

connectionString
stringRequired
includeIndexes
boolean
tableName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Prisma Accelerate Regions

Description

Retrieve all available regions for prisma accelerate. returns regions where accelerate global database cache can be deployed. use for cache region selection to minimize latency for your users.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Database Backups

Description

Retrieve list of available backups for a specific database. returns backup details including status, size, type, and restoration readiness. use for backup monitoring, restoration planning, and compliance auditing.

Action Parameters

databaseId
stringRequired
limit
integerDefaults to 25

Action Response

data
arrayRequired
error
string
meta
objectRequired
pagination
objectRequired
successful
booleanRequired

Tool Name: List Database Connections

Description

Retrieve paginated list of connections for a specific database. returns connection details including names, creation dates, and database context. use for api key management, security audits, and access control.

Action Parameters

cursor
string
databaseId
stringRequired
limit
integerDefaults to 100

Action Response

data
arrayRequired
error
string
pagination
objectRequired
successful
booleanRequired

Tool Name: List Project Databases

Description

Retrieve paginated list of databases for a specific prisma project. returns database details including status, region, and project context. use for database discovery, monitoring, and project administration.

Action Parameters

cursor
string
limit
integerDefaults to 100
projectId
stringRequired

Action Response

data
arrayRequired
error
string
pagination
objectRequired
successful
booleanRequired

Tool Name: List Prisma Postgres Regions

Description

Retrieve all available regions for prisma postgres. returns regions where prisma postgres databases can be deployed with current availability status. use for region selection during database creation and capacity planning.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Prisma Projects

Description

Retrieve paginated list of prisma projects accessible to authenticated user. returns project ids, names, workspace info, and timestamps with cursor-based pagination. use for project discovery, ui selection flows, and administrative operations.

Action Parameters

cursor
string
limit
integerDefaults to 100

Action Response

data
arrayRequired
error
string
pagination
objectRequired
successful
booleanRequired

Tool Name: List Prisma Workspaces

Description

Retrieve paginated list of prisma workspaces accessible to authenticated user. returns workspace ids, names, creation timestamps with cursor-based pagination. use for workspace discovery, ui selection flows, and administrative operations.

Action Parameters

cursor
string
limit
integerDefaults to 100

Action Response

data
arrayRequired
error
string
pagination
objectRequired
successful
booleanRequired

Tool Name: Restore Database Backup

Description

Restore database backup to new database instance. creates new database from existing backup with specified name. operation is asynchronous - monitor the returned database status for completion. restoration may take several minutes.

Action Parameters

backupId
stringRequired
databaseId
stringRequired
targetDatabaseName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Transfer Prisma Project

Description

Transfer prisma project ownership to another user. changes project ownership to recipient specified by their access token. current owner loses access unless explicitly granted by new owner.

Action Parameters

id
stringRequired
recipientAccessToken
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Database Connection

Description

Permanently delete database connection and revoke api key access. warning: this immediately revokes database access for any applications using this connection string. ensure no critical systems depend on this connection.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Prisma Database

Description

Permanently delete prisma database and all stored data. warning: this action cannot be undone. all data in the database will be permanently destroyed. default databases typically cannot be deleted.

Action Parameters

databaseId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Prisma Project

Description

Permanently delete prisma project and all associated resources. warning: this action cannot be undone. all databases, environments, and project data will be permanently destroyed. use with extreme caution in production environments.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired