Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.phrony.com/llms.txt

Use this file to discover all available pages before exploring further.

Each sample declares manifest inputs. You can bring them into a workspace from the Phrony dashboard or with the CLI. The Phrony team maintains an open-source registry on GitHub—phrony-platform/manifests—with curated samples you can clone or browse outside this documentation repo.

​
In the Phrony dashboard

Open Import manifest on the agents list, or Apply manifest under Agent options on an agent. Upload the sample YAML file from this repo. After checks pass, map integration and llm_provider inputs (and any string inputs such as ids) in the dialog—defaults in each folder’s phrony.values.yaml show the shape of the resolved map. Then dry run and apply. See Manifest — Where you use manifests in Phrony.

​
With the CLI

Run phrony lint (offline schema check), then phrony plan / phrony apply with merged inputs—see Plan, apply, and diff. For includes and --values, see Init and lint. Defaults live in phrony.values.yaml next to each manifest entry (same format as --values / PHRONY_MANIFEST_VALUES on plan and apply). After apply (either path), finish integration connection in the Phrony dashboard when prompted.

​
Files in this documentation repository

The paths below are under samples/manifests/ in the docs source. Selected samples also appear in phrony-platform/manifests.
PathPurpose
telegram-public-api-notify/telegram-public-api-notify.yamlHITL: API trigger → cat fact (public HTTP) → Telegram (approval). Details
gmail-new-mail-hitl/gmail-new-mail-hitl.yamlHITL: Gmail new message event (GMAIL_NEW_GMAIL_MESSAGE) → fetch, label, reply draft. Details
From a local clone of this documentation repository, run: 
phrony lint samples/manifests/telegram-public-api-notify/telegram-public-api-notify.yaml
phrony lint samples/manifests/gmail-new-mail-hitl/gmail-new-mail-hitl.yaml
Pass --values <path> if your values file is not beside the YAML path (same behavior as phrony plan / phrony apply).

​
Telegram + public API sample

The telegram-public-api-notify/ folder is a relay demo: an API trigger starts a run on a HITL root agent. Each run fetches one cat fact from a read-only public HTTP API (https://catfact.ninja/fact) and sends that fact to Telegram. Why HITL: the Telegram send operation uses require approval, so a human can approve or reject the outbound message in the Phrony dashboard before it is delivered. How to use it
  1. Apply the manifest from the Phrony dashboard (Import manifest / Apply manifest) or with phrony apply and --values pointing at the folder’s phrony.values.yaml. Set telegram_chat_id to the destination chat id (in the dialog or in the values file).
  2. Connect Telegram (bot token). Cat Facts (public HTTP) is declared in the manifest (read-only, no auth).
  3. Call the agent’s API trigger from your automation (optional context in the payload). The operator approves the send when prompted.
  4. See Human in the loop (HITL).

​
Gmail new mail — label + draft sample

The gmail-new-mail-hitl/ manifest wires a Gmail built-in integration to Composio’s “New Gmail Message Received” trigger. Per Composio Gmail toolkit documentation, that trigger’s slug is GMAIL_NEW_GMAIL_MESSAGE (poll-based; latency is typically on the order of a minute unless you use a different ingress). The manifest sets eventSlug: GMAIL_NEW_GMAIL_MESSAGE and eventConfig.userId: me; align eventSlug with what your Phrony workspace shows for that trigger if it differs. On each new message, the HITL agent fetches the message, applies a triage label (label id from triage_label_id), and creates a reply draft in the same thread. Label and draft operations use require approval so humans can review before Gmail is modified. How to use it
  1. Apply the manifest from the Phrony dashboard or with phrony apply and the sample phrony.values.yaml. Pick your Gmail integration and set triage_label_id to a real Gmail label id (use list_gmail_labels in a test run or Gmail’s UI; not the human-readable name alone).
  2. Connect Gmail (OAuth) if prompted.
  3. Ensure the event trigger is enabled in the dashboard; new mail in the watched mailbox should start runs.
  4. See Human in the loop (HITL) and Trigger ingress.
See Manifest for document shape, placeholders, and dashboard dry run. See Plan, apply, and diff for phrony plan, phrony apply, and phrony diff.