EspoCRM

SKILL.md

---
name: oo-espocrm
description: "EspoCRM (espocrm.com). Use this skill for ANY EspoCRM request — reading, creating, updating, and deleting data. Whenever a task involves EspoCRM, use this skill instead of calling the API directly."
allowed-tools: [Bash(oo *)]
metadata:
  title: "EspoCRM"
  author: "OOMOL"
  version: "1.0.0"
  service: "espocrm"
  categories: "Productivity, Marketing"
  homepage: "https://www.espocrm.com/"
  icon: "https://static.oomol.com/logo/third-party/Espocrm.svg"
---

# EspoCRM

Operate **EspoCRM** through your OOMOL-connected account. This skill calls the `espocrm` connector with the [oo CLI](https://github.com/oomol-lab/oo-cli); OOMOL injects credentials server-side, so you never handle raw tokens.

Category: Productivity, Marketing. Exposes 7 action(s).

## Running an action

Assume the user has already installed the oo CLI, signed in, and connected EspoCRM. **Do not run `oo auth login` or open the connection URL proactively — just run the action.** Fall back to [First-time setup](#first-time-setup) only when a command actually fails with an auth or connection error.

**1. Inspect the contract** to get the authoritative input/output schema before building a payload:

```bash
oo connector schema "espocrm" --action "<action_name>"
```

**2. Run the action** with a JSON payload that matches the input schema:

```bash
oo connector run "espocrm" --action "<action_name>" --data '<json>' --json
```

- `--data` takes a JSON object string or `@path/to/file.json`; omit it to send `{}`.
- The response is `{ "data": ..., "meta": { "executionId": "..." } }`; the execution id lives under `meta.executionId`.

Each action below links to a reference file with its purpose and exact commands. Read the linked file, then fetch the live schema with `oo connector schema` before constructing `--data`.

## Available actions

- [`create_record`](actions/create_record.md) — Create one EspoCRM record for the specified entity type.
- [`delete_record`](actions/delete_record.md) — Delete one EspoCRM record by entity type and record identifier.
- [`get_app_user`](actions/get_app_user.md) — Get the current EspoCRM user data for the configured connection, including ACL and preferences when returned.
- [`get_metadata`](actions/get_metadata.md) — Get EspoCRM application metadata, optionally narrowed to one metadata path.
- [`get_record`](actions/get_record.md) — Get one EspoCRM record by entity type and record identifier.
- [`list_records`](actions/list_records.md) — List EspoCRM records for an entity type with optional pagination, sorting, and where clauses.
- [`update_record`](actions/update_record.md) — Update selected fields on one EspoCRM record.

## Safety

- Read actions (get / list / search) are safe to run directly.
- **Create, update, send, or post actions change EspoCRM state — confirm the exact payload and effect with the user before running.**
- **Delete or remove actions are destructive — always confirm the target and get explicit approval first.**

## First-time setup

These are **one-time** steps — do not repeat them on every call. Run a step only when a command fails for the matching reason.

- **`oo: command not found`** — install the oo CLI (other platforms: <https://cli.oomol.com/install-guide.md>):

  ```bash
  curl -fsSL https://cli.oomol.com/install.sh | bash    # macOS / Linux
  ```

  ```powershell
  irm https://cli.oomol.com/install.ps1 | iex           # Windows PowerShell
  ```

- **Not signed in / authentication error** — sign in to your OOMOL account once:

  ```bash
  oo auth login
  ```

- **`scope_missing` / `credential_expired` / `app_not_ready` / `app_not_found`** — EspoCRM is not connected, or the connection expired or lacks a scope. Connect once (auth type: API key) at:

  ```text
  https://console.oomol.com/app-connections?provider=espocrm
  ```

- **HTTP 402 / `OOMOL_INSUFFICIENT_CREDIT`** — billing stop. Recharge at `https://console.oomol.com/billing/token-recharge` before retrying.

## Resources

- EspoCRM homepage: https://www.espocrm.com/