Skip to content

Add Email Delivery Reporter agent in tdx CLI format#437

Merged
toru-takahashi merged 3 commits intotreasure-data:masterfrom
ko47kmr:improve-email-delivery-reporter
Apr 17, 2026
Merged

Add Email Delivery Reporter agent in tdx CLI format#437
toru-takahashi merged 3 commits intotreasure-data:masterfrom
ko47kmr:improve-email-delivery-reporter

Conversation

@ko47kmr
Copy link
Copy Markdown
Contributor

@ko47kmr ko47kmr commented Apr 15, 2026

Summary

  • Add Email Delivery Reporter agent with flat directory structure compatible with tdx agent push
  • knowledge_bases/ placed at project root (not nested in agent/) so all resources are recognized during push
  • Use DOMAIN placeholder in KB filename and @ref references for clear, explicit setup instructions
  • Define tables explicitly in KB config (events, error_events, subscription_events) instead of empty array
  • Remove unused Timezone field from Overall Summary form (not referenced in system prompt or report specs)
  • Remove unsupported Subject filter from Campaign Details form (not implemented in CampaignSummary spec)
  • README rewritten as self-contained setup guide with 5-point DOMAIN replacement checklist and copy-pasteable commands

File Structure

email-delivery-reporter/
├── tdx.json
├── README.md
├── Email Delivery Dashboard/
│   ├── agent.yml
│   └── prompt.md
├── knowledge_bases/
│   ├── delivery_email_DOMAIN.yml    ← user replaces DOMAIN
│   ├── OverallSummary_Spec.md
│   └── CampaignSummary_Spec.md
├── form_interfaces/
│   ├── Overall Summary.yml
│   └── Campaign Details.yml
└── docs/japanese/

Test plan

  • Clone repo, follow README Quick Start steps to replace DOMAIN and deploy with tdx agent push . -f
  • Verify all 6 resources are created (1 agent, 1 DB KB, 2 text KBs, 2 form interfaces)
  • Run Overall Summary report with date range
  • Run Campaign Details report with campaign_id
  • Verify no Timezone or Subject fields appear in form interfaces

🤖 Generated with Claude Code

Add the Email Delivery Reporter agent for Treasure Data Engage with
a flat directory structure compatible with `tdx agent push`. Key design
decisions:

- knowledge_bases/ at project root (not nested in agent/) so tdx push
  recognizes all resources
- DOMAIN placeholder in KB filename and references for clear setup
- KB tables explicitly defined (events, error_events, subscription_events)
- Remove unused Timezone field from Overall Summary form (not referenced
  in system prompt or specs)
- Remove unsupported Subject filter from Campaign Details form (not
  implemented in CampaignSummary spec)
- README written as self-contained setup guide with explicit 5-point
  DOMAIN replacement checklist

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ko47kmr ko47kmr requested a review from a team as a code owner April 15, 2026 05:09
Copilot AI review requested due to automatic review settings April 15, 2026 05:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new “Email Delivery Reporter” agent package under engage-box/ intended to be deployable via tdx agent push, including database/text knowledge bases, form interfaces, and English/Japanese prompt/docs.

Changes:

  • Introduces a new Email Delivery Dashboard agent config + system prompt for generating React/Plotly dashboards.
  • Adds DB + text knowledge bases and two form interfaces for “Overall Summary” and “Campaign Details” flows.
  • Adds root README and Japanese reference docs for setup/usage guidance.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 13 comments.

Show a summary per file
File Description
engage-box/email-delivery-reporter/tdx.json Adds the tdx project manifest.
engage-box/email-delivery-reporter/knowledge_bases/delivery_email_DOMAIN.yml Defines the database KB and exposed tables/queries.
engage-box/email-delivery-reporter/knowledge_bases/OverallSummary_Spec.md Adds the Overall Summary report specification (text KB).
engage-box/email-delivery-reporter/knowledge_bases/CampaignSummary_Spec.md Adds the Campaign Details report specification (text KB).
engage-box/email-delivery-reporter/form_interfaces/Overall Summary.yml Adds the “Overall Summary” form interface and prompt template.
engage-box/email-delivery-reporter/form_interfaces/Campaign Details.yml Adds the “Campaign Details” form interface and prompt template.
engage-box/email-delivery-reporter/Email Delivery Dashboard/prompt.md Adds the English system prompt describing execution/tooling rules.
engage-box/email-delivery-reporter/Email Delivery Dashboard/agent.yml Adds the agent definition, outputs, and KB tool wiring.
engage-box/email-delivery-reporter/docs/japanese/prompt_ja.md Adds Japanese reference translation of the system prompt.
engage-box/email-delivery-reporter/docs/japanese/README_JA.md Adds Japanese setup/usage documentation.
engage-box/email-delivery-reporter/docs/japanese/OverallSummary_Spec_ja.md Adds Japanese reference translation of the Overall Summary spec.
engage-box/email-delivery-reporter/docs/japanese/CampaignSummary_Spec_ja.md Adds Japanese reference translation of the Campaign Details spec.
engage-box/email-delivery-reporter/README.md Adds a root, self-contained Quick Start/setup guide for CLI deployment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread engage-box/email-delivery-reporter/knowledge_bases/CampaignSummary_Spec.md Outdated
Comment thread engage-box/email-delivery-reporter/Email Delivery Dashboard/prompt.md Outdated
Comment thread engage-box/email-delivery-reporter/docs/japanese/README_JA.md Outdated
Comment thread engage-box/email-delivery-reporter/docs/japanese/CampaignSummary_Spec_ja.md Outdated
Comment thread engage-box/email-delivery-reporter/README.md
Comment thread engage-box/email-delivery-reporter/Email Delivery Dashboard/prompt.md Outdated
Comment thread engage-box/email-delivery-reporter/docs/japanese/prompt_ja.md Outdated
Comment thread engage-box/email-delivery-reporter/docs/japanese/README_JA.md Outdated
Comment thread engage-box/email-delivery-reporter/docs/japanese/OverallSummary_Spec_ja.md Outdated
Kona (Koshi Nakamura) and others added 2 commits April 15, 2026 15:31
- Add missing tables to KB config (daily_summary, event_master,
  email_events) referenced by report specs
- Fix contradictory filter config: campaign_id and journey_id were both
  required:true with exclusive_with, making valid requests impossible.
  Changed to required:false with "exactly one" rule in filter_notes
- Align prompt tool names: render_plotly_chart → new_plot to match
  the actual output function defined in agent.yml
- Update docs/japanese/ to reflect new file structure (remove references
  to old filenames like system_prompt.md, knowledge_base_*.md)
- Remove Subject filter references from README_JA.md
- Fix cross-reference paths in Japanese spec files
- Add GNU sed variant to README for Linux/Windows compatibility

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Resolved conflict in engage-box/email-delivery-reporter/README.md by:
- Keeping the new tdx CLI format structure from improve-email-delivery-reporter
- Integrating valuable content from master (Overview, Features, Report Components)
- Maintaining English as primary language (Japanese docs in separate files)
- Combining troubleshooting sections from both versions

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@toru-takahashi toru-takahashi merged commit 560163f into treasure-data:master Apr 17, 2026
3 checks passed
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.

3 participants