Overview
Create an AGENTS.md that helps AI agents (OpenClaw, Claude Code, Cursor, etc.) use the Partiful CLI effectively without reading every help page.
Proposed Content
- Capability summary — What the CLI can and can't do
- Common workflows — Step-by-step flows:
- "Create event and invite friends" (contacts search → create → invite)
- "Check who's coming" (events list → guests list)
- "Send a text blast" (events list → blasts send)
- "Clone a recurring event" (events clone)
- Decision tree — Route from user intent to the right command
- Schema reference — Point agents to
partiful schema <path> for parameter details
- Auth status check — Always run
partiful doctor or partiful auth status first
- Error recovery — Common errors (403 permission, missing userId, upload failures) and fixes
- Gotchas — Things agents get wrong:
- Contacts don't expose emails/phone numbers (privacy)
- Guest lists only work for events you host
- Image upload may fail; use
--poster or --poster-search as fallback
Format
Follow the emerging AGENTS.md convention (used by Cursor, Claude Code, OpenClaw).
Overview
Create an AGENTS.md that helps AI agents (OpenClaw, Claude Code, Cursor, etc.) use the Partiful CLI effectively without reading every help page.
Proposed Content
partiful schema <path>for parameter detailspartiful doctororpartiful auth statusfirst--posteror--poster-searchas fallbackFormat
Follow the emerging AGENTS.md convention (used by Cursor, Claude Code, OpenClaw).