MCP Tools Reference
Complete reference for all tools exposed by the Portabase MCP server.
The Portabase MCP server exposes 12 tools grouped into three categories: Agents, Databases, and Backups.
Agents
list_agents
List all agents accessible to the authenticated user.
Parameters: none
Returns: Array of agent objects.
get_agent
Get details for a specific agent, including its associated databases.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Agent ID |
Returns: Agent object with associated databases.
create_agent
Create a new agent, optionally scoped to an organization.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Agent name (min 1 character) |
organizationId | string (UUID) | No | Organization ID to scope the agent to |
Returns: Created agent object.
delete_agent
Delete an agent by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Agent ID |
Returns: Confirmation message.
get_agent_key
Get the edge key for an agent. This key is used by the agent binary to authenticate with Portabase.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Agent ID |
Returns: Object containing the edge key.
The edge key grants the agent access to your Portabase instance. Treat it like a password and never expose it in logs or version control.
Databases
list_databases
List all databases accessible to the authenticated user.
Parameters: none
Returns: Array of database objects.
get_database
Get details for a specific database.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Database ID |
Returns: Database object.
get_database_status
Get the current status of a database, including the latest backup and restoration state.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Database ID |
Returns: Status object with backup and restore state.
Backups
list_backups
List all backups for a specific database, ordered by most recent first.
| Parameter | Type | Required | Description |
|---|---|---|---|
databaseId | string | Yes | Database ID |
Returns: Array of backup objects.
get_backup
Get details for a specific backup, including its storage locations.
| Parameter | Type | Required | Description |
|---|---|---|---|
databaseId | string | Yes | Database ID |
backupId | string | Yes | Backup ID |
Returns: Backup object with storages array. Use the id values from storages as backupStorageId in trigger_restore.
trigger_backup
Trigger an immediate backup for a database.
| Parameter | Type | Required | Description |
|---|---|---|---|
databaseId | string | Yes | Database ID |
Returns: Backup job object.
Returns 409 Conflict if a backup is already running for this database.
trigger_restore
Trigger a database restore from a specific backup storage. Use get_backup to find available backupStorageId values.
| Parameter | Type | Required | Description |
|---|---|---|---|
databaseId | string | Yes | Database ID |
backupId | string (UUID) | Yes | Backup ID |
backupStorageId | string (UUID) | Yes | Backup storage ID (from get_backup storages list) |
Returns: Restore job object.
Returns 409 Conflict if a restore is already running for this database.
Last updated on