AgentDBDocs

Package and template operations

Install ready-made schemas and apps (CRM, todos, kanban, CMS, forms...).

Start with: packages_list, packages_install, packages_get, packages_uninstall.

4 operations. Discover them from an agent with agentdb_capabilities {"category": "packages_apps"}.

#packages_get

stable added in 1.0.0-rc.6 read-only

A package's (or template's) manifest.

MCP tool
packages_get
REST
GET /v1/workspaces/{ws}/packages/{package} scope schema:read
CLI
agentdb packages get

Arguments

ArgumentTypeRequiredDescription
packagestringyesPackage or template name
workspacestringWorkspace id (preferred), slug or exact name. Omit for the default workspace. Resolve names once with workspace_select.

Example

MCP
{
  "tool": "packages_get",
  "arguments": {
    "package": "agent_crm"
  }
}
MCP via agentdb_execute
{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "packages_get",
    "arguments": {
      "package": "agent_crm"
    }
  }
}
REST
curl -s "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/packages/agent_crm" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"
CLI
agentdb packages get [options] <name>

#packages_install

stable added in 1.0.0-rc.6 changes data

Install or upgrade a versioned schema package (objects, fields, unique keys, relationships, views, flows, jobs, retention) or a built-in template ({template: "agent_crm"}, the CRM to use; crm is legacy; apps agent_todos, agent_kanban, agent_projects; business packs support, recruit, property, inventory, assets; optionally {version}). Idempotent and additive: never removes, retypes or touches records; differences (also customised flows and jobs) are reported as conflicts and the workspace's definition is kept; views and recipes that need a conflicting field or value are reduced or skipped (needs_attention), never failed. automations=true also creates the package's flows, jobs and approval policies (owners/admins); sample_data=true adds a synthetic demo dataset once. Run dry_run=true first for the diff (would_fail shows an install error). packages_get shows permission and approval templates to apply yourself.

MCP tool
packages_install
REST
POST /v1/workspaces/{ws}/packages/install scope schema:write
CLI
agentdb packages install

Arguments

ArgumentTypeRequiredDescription
packageobjectobject
templatestringstring
versionstringThe current version of the item. The call fails with VERSION_CONFLICT if it changed.
dry_runbooleanboolean, default false
automationsbooleanboolean, default false
sample_databooleanboolean, default false
idempotency_keystringOptional retry key ([A-Za-z0-9._:-], max 255). Repeating a call with the same key and arguments returns the original result without writing again.
workspacestringWorkspace id (preferred), slug or exact name. Omit for the default workspace. Resolve names once with workspace_select.

Example

MCP
{
  "tool": "packages_install",
  "arguments": {
    "template": "agent_crm",
    "dry_run": true
  }
}
MCP via agentdb_execute
{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "packages_install",
    "arguments": {
      "template": "agent_crm",
      "dry_run": true
    }
  }
}
REST
curl -s -X POST "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/packages/install" \
  -H "Authorization: Bearer $AGENTDB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"template":"agent_crm","dry_run":true}'
CLI
agentdb packages install [options] [manifest_file]

#packages_list

stable added in 1.0.0-rc.6 read-only

Installed schema packages and the built-in templates (agent_crm: recommended).

MCP tool
packages_list
REST
GET /v1/workspaces/{ws}/packages scope schema:read
CLI
agentdb packages list

Arguments

ArgumentTypeRequiredDescription
workspacestringWorkspace id (preferred), slug or exact name. Omit for the default workspace. Resolve names once with workspace_select.

Example

MCP
{
  "tool": "packages_list",
  "arguments": {}
}
MCP via agentdb_execute
{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "packages_list",
    "arguments": {}
  }
}
REST
curl -s "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/packages" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"
CLI
agentdb packages list [options]

#packages_uninstall

stable added in 1.0.0-rc.6 changes data

Forget an installed package: remove its views, delete its flows and approval policies and cancel its jobs (remove_views / remove_automations=false keep them). Objects, fields, records and retention settings are kept.

MCP tool
packages_uninstall
REST
DELETE /v1/workspaces/{ws}/packages/{package} scope schema:write
CLI
agentdb packages uninstall

Arguments

ArgumentTypeRequiredDescription
remove_viewsbooleanboolean, default true
remove_automationsbooleanboolean, default true
packagestringyesPackage name
idempotency_keystringOptional retry key ([A-Za-z0-9._:-], max 255). Repeating a call with the same key and arguments returns the original result without writing again.
workspacestringWorkspace id (preferred), slug or exact name. Omit for the default workspace. Resolve names once with workspace_select.

Example

MCP
{
  "tool": "packages_uninstall",
  "arguments": {
    "package": "agent_crm",
    "remove_views": false
  }
}
MCP via agentdb_execute
{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "packages_uninstall",
    "arguments": {
      "package": "agent_crm",
      "remove_views": false
    }
  }
}
REST
curl -s -X DELETE "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/packages/agent_crm" \
  -H "Authorization: Bearer $AGENTDB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"remove_views":false}'
CLI
agentdb packages uninstall [options] <name>