Skip to content

added new rule for flow samples and playbook for autonomous ai agent - #31

Open
Joezanini wants to merge 1 commit into
mainfrom
ai-agent-auto
Open

added new rule for flow samples and playbook for autonomous ai agent#31
Joezanini wants to merge 1 commit into
mainfrom
ai-agent-auto

Conversation

@Joezanini

Copy link
Copy Markdown
Collaborator

Playbook Pull Request

For internal contributors submitting a new Playbook. See CONTRIBUTING.md for the full submission process from branch naming through merge.


Required Files

Before submitting, confirm your Playbook folder under playbooks/<tool-slug>/ includes:

  • Playbook folder at playbooks/<tool-slug>/ with a kebab-case name matching the third-party tool slug
  • README.md with all 6 required sections: Use Case Overview, Architecture, Prerequisites, Code Scaffold, Deployment Guide, Known Limitations
  • APPHUB.yaml present and correctly formatted (see below)
  • diagrams/ folder present (e.g. with an architecture diagram)
  • src/ folder present with sample code

APPHUB.yaml format

Ensure APPHUB.yaml is correctly formatted per the APPHUB schema in CONTRIBUTING.md: all required fields filled, valid values for vertical and webex_component; status = draft or review (do not set published). The Validate then Publish to Integration workflow will fail if required fields are missing or invalid.


Author Checklist

Before submitting, confirm:

  • This PR touches only one playbook folder (see CONTRIBUTING.md)
  • All 6 required sections present in README.md (Use Case Overview, Architecture, Prerequisites, Code Scaffold, Deployment Guide, Known Limitations)
  • APPHUB.yaml complete with all required fields
  • Branch name follows playbook/<tool-slug>
  • Code scaffold connects to a real, documented Webex API endpoint
  • Deployment guide tested end-to-end
  • No competitor tools (Genesys, NICE, Five9, Talkdesk) as primary integration targets

Review Process and Turnaround

  • Automated validation: When you open or update this PR, the Validate then Publish to Integration workflow runs and posts a comment with results. The PR cannot merge until all checks pass. Fix any failures and push to re-run.
  • Human review: After validation passes, a reviewer performs a ~15-minute spot-check using the review criteria in CONTRIBUTING.md. You may receive change requests; push commits to this branch to address them.
  • Turnaround: Reviewers aim to complete the initial spot-check within 3 business days; you will be notified of any change requests in the PR.

Reviewer: 15-Minute Spot-Check

  • Does the scaffold connect to a real Webex API, SDK, or Developer Tool?
  • Is the deployment guide followable by a competent developer?
  • Does this duplicate an existing Playbook?

Self-Attestation

By submitting this PR I confirm that the deployment guide is accurate to the best of my knowledge and that Webex does not guarantee the functional accuracy of this Playbook.

@Joezanini
Joezanini requested a review from adamweeks March 24, 2026 18:09
@github-actions

Copy link
Copy Markdown

Playbook Validation Results

Playbook: playbooks/ai-agent-autonomous

  • README.md exists
  • README.md contains all 6 required section headers
  • APPHUB.yaml exists
  • All required APPHUB.yaml fields present and non-empty
  • APPHUB.yaml categories has at least one value
  • APPHUB.yaml friendly_id ends with -playbook
  • APPHUB.yaml tag_line is valid (86/128 chars)
  • APPHUB.yaml product_types is valid
  • APPHUB.yaml app_context values are valid
  • /diagrams/ folder exists
  • /src/ folder exists
  • Folder name is kebab-case

Validation passed.

@github-actions

Copy link
Copy Markdown

Playbook Details (from APPHUB.yaml)

Field Value
Playbook title Webex Contact Center + Autonomous AI Agent Flow (Package Tracking)
Third-party tool Webex AI Agent Studio
Categories customer-support, self-service-bots, workflow-automation
Estimated implementation time 4-8 hours

Auto-generated from APPHUB.yaml.

@github-actions

Copy link
Copy Markdown

Contentstack: Published to integration

ai-agent-autonomous-playbook


Published playbooks are available in the integration environment.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's combine this into the main README.md for this playbook. Having two readme's would cause confusion

@@ -0,0 +1,53 @@
# Webex Contact Center — Autonomous AI Agent (Package Tracking) Flow Playbook

This Playbook bundles Flow Designer assets from the [`WebexSamples/webex-contact-center-flows`](https://github.com/WebexSamples/webex-contact-center-flows) repository (`ai-agent-autonomous`).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repo is private, it will show up as a 404 to anyone without access. We should remove the link to it.

@adamweeks

Copy link
Copy Markdown
Collaborator
  1. Add an explicit rule under “Step 3 — Create the Playbook folder and files”
    After the tree that shows README.md at playbooks//, add something like:

Single README policy: The Playbook must have exactly one file named README.md, at playbooks//README.md (the six required sections). Do not copy README.md from the source directory into playbooks//src/.
Upstream content: Before copying, read the source README.md (and any README*.md). Merge anything readers need (activity list, prerequisites, links) into the appropriate sections of playbooks//README.md (especially Code Scaffold and Deployment Guide). If you need to preserve the upstream file verbatim for traceability, save it as a different filename (e.g. src/UPSTREAM-README.md or src/sample-notes.md), not README.md.
That removes duplicate README.md while keeping required playbook structure.

  1. Tighten the “Copy the sample tree” subsection
    Where it says to recursively copy everything, qualify it:

Recursively copy all files and folders except root-level README.md (and optionally other root-level README*.md if you want zero ambiguity).
Or: copy everything, then delete playbooks//src/README.md if present, after merging its content into the root README.
Pick one strategy (exclude-on-copy vs copy-then-delete) so implementers don’t do both.

  1. Update the Cursor rule (.cursor/rules/import-playbook-flow-designer.mdc) in sync
    In the Copy bullet, add one line: Do not place a second README.md under src/; merge upstream README into playbooks//README.md only.

  2. Optional: call out the “why” for reviewers
    One line for the PR:

Rationale: App Hub / repo convention expects a single playbook README.md; vendored src/README.md duplicates structure and confuses “which file do I edit?” Merging upstream text into the canonical README keeps one source of truth.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants