Skip to content

docs: AGENTS.md — AI agent integration guide #48

@KalebCole

Description

@KalebCole

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

  1. Capability summary — What the CLI can and can't do
  2. 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)
  3. Decision tree — Route from user intent to the right command
  4. Schema reference — Point agents to partiful schema <path> for parameter details
  5. Auth status check — Always run partiful doctor or partiful auth status first
  6. Error recovery — Common errors (403 permission, missing userId, upload failures) and fixes
  7. 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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions