diff --git a/docs/base-app/agents/best-practices.mdx b/docs/base-app/agents/best-practices.mdx deleted file mode 100644 index 81034eb8..00000000 --- a/docs/base-app/agents/best-practices.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 'Chat Agent Best Practices' -description: 'Guidelines and recommendations for building effective chat agents' -sidebarTitle: 'Best Practices' ---- - -### Best practices - -1. Always validate content structures -2. Provide fallbacks for unsupported clients -3. Test across client versions -4. Limit message and metadata size -5. Follow [XIP-67](https://community.xmtp.org/t/xip-67-inline-actions/941) -6. Your agent should respond to both direct messages and group chat messages (if applicable). -7. For direct messages, it should automatically respond. -8. We recommend reacting to messages with an emoji (like 👀or ⌛) to indicate the message was received, while the response is processing. -9. For group chat messages, agents should only respond if they are mentioned with the "@" symbol and the agent's name. (example "@bankr"), OR if the user replies directly to a message from the agent (using the reply content type). - -For group chat messages, agents should only respond if they are mentioned with the "@" symbol and the agent's name. (example "@bankr"), OR if the user replies directly to a message from the agent (using the reply content type). diff --git a/docs/base-app/agents/building-quality-agents.mdx b/docs/base-app/agents/building-quality-agents.mdx index 17ea39c9..f63ec37e 100644 --- a/docs/base-app/agents/building-quality-agents.mdx +++ b/docs/base-app/agents/building-quality-agents.mdx @@ -1,16 +1,16 @@ --- -title: 'Building Quality Agents for Base App' -description: Learn the best practices and guidelines for creating high-quality agents that get featured in Base App -sidebarTitle: 'Building Quality Agents' +title: 'UX Guidelines' +description: Learn the best practices and guidelines for creating quality agents +sidebarTitle: 'UX Guidelines' --- -As you start building, review these guidelines to understand what we look for when featuring agents in the Base app. We recommend trying out existing agents in the app first to get a feel for the quality bar, what works well, and areas for improvement. +As you start building, review these guidelines to understand what makes an agent successful in the Base app. We recommend trying out existing agents in the app first to get a feel for the quality bar, what works well, and areas for improvement. ## Build a high quality foundation Your agent should provide a seamless, professional experience that users will want to engage with repeatedly. Here are the core requirements: -### Response Behavior +### Responding to messages **Multi-Channel Support** - Respond to both DMs and group chats appropriately @@ -53,7 +53,7 @@ Your agent's first impression is critical. The onboarding message should immedia 1. **Introduce the agent** - Quick, friendly greeting with the agent's name 2. **Explain capabilities** - Clear, specific examples of what it can do -3. **Provide next steps** - Give users an obvious action to take +4. **Use quick select buttons** - Make it easy for users to select an action to take with the agent ### Example: High-Quality Onboarding @@ -106,7 +106,7 @@ Focus on helping users: ### Design for Engagement **Build Natural Growth Loops** -- Include features that encourage sharing and re-engagement +- Include features that encourage sharing, re-engagement, and habit forming - Make it beneficial for users to invite others - Create ongoing value that brings users back @@ -132,15 +132,4 @@ As users complete actions with your agent: - **Recurring value** - Automated tasks, alerts, or regular check-ins - **Gamification** - Points, levels, or achievement systems -## Next steps -Once you've built your agent following these guidelines: - -1. **Test thoroughly** - Try your agent in different scenarios and conversation types -2. **Get feedback** - Have others test and provide honest feedback -3. **Iterate quickly** - Make improvements based on real user interactions -4. **Submit for review** - Follow the submission guidelines when ready - -Remember: agents often go through multiple rounds of feedback before being featured. Focus on creating genuine value and a polished user experience that people will love using repeatedly. - -For technical implementation details, see our [Chat Agents guide](/base-app/agents/chat-agents). diff --git a/docs/base-app/agents/chat-agents.mdx b/docs/base-app/agents/chat-agents.mdx index 36f185de..f777017c 100644 --- a/docs/base-app/agents/chat-agents.mdx +++ b/docs/base-app/agents/chat-agents.mdx @@ -1,7 +1,7 @@ --- title: 'Chat Agents in Base App' description: Learn how to build chat agents for Base App, using XMTP -sidebarTitle: 'Chat Agents' +sidebarTitle: 'Overview' --- This guide will cover how you can get started building messaging agents for Base App, using XMTP, a decentralized messaging protocol. Discover a fast, easy way to build and get distribution in Base App. diff --git a/docs/base-app/agents/getting-featured.mdx b/docs/base-app/agents/getting-featured.mdx index 32f70875..b5efcf9a 100644 --- a/docs/base-app/agents/getting-featured.mdx +++ b/docs/base-app/agents/getting-featured.mdx @@ -1,11 +1,23 @@ --- -title: 'Getting Your Agent Featured' -description: 'Learn how to submit your chat agent for review and get featured in Base App' -sidebarTitle: 'Getting Featured' +title: 'Get Feedback on Your Agent' +description: 'Learn how to submit your chat agent for feedback from the Base and XMTP teams' +sidebarTitle: 'Get Feedback' --- -## Getting featured +## Launch Check-list + +Review this checklist before submitting your agent for feedback. + +* ✔ Agent has a Basename (.base.eth) +* ✔ Agent reacts to messages with 👀 emoji +* ✔ Agent has a clear onboarding message that introduces itself, its capabilities, and gives the user a clear next step to take. +* ✔ Agent utilizes quick select buttons when necessary to make actions easier on the user. +* ✔ Agent solves a clear problem and provides value to users. + +Fill out [this form](https://app.deform.cc/form/52b71db4-bfa2-4ef5-a954-76c66250bdd2) to submit your agent for feedback. You will hear back from us within **5 business days**, and someone from the **Base** or **XMTP** team will contact you through DM on the Base app. Make sure to check your requests! + +We recommend posting a demo of your agent on the **Base app social feed** to get feedback from the community. + + -Fill out the form [here](https://app.deform.cc/form/52b71db4-bfa2-4ef5-a954-76c66250bdd2/?page_number=0) to submit your agent for review. Note, agents often go through multiple rounds of feedback before they are ready to be featured. Once approved, your agent will be featured in Base App. You will hear back from us within 5 business days. -Need help or have feature requests? Visit [https://community.xmtp.org/](https://community.xmtp.org/) diff --git a/docs/base-app/agents/why-agents.mdx b/docs/base-app/agents/why-agents.mdx deleted file mode 100644 index 87d545e0..00000000 --- a/docs/base-app/agents/why-agents.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 'Why Build Chat Agents?' -description: 'Discover the power of messaging agents and their potential impact on Base App' -sidebarTitle: 'Why Agents?' ---- - -## Why agents? - -Messaging is the largest use-case in the world, but it's more than just conversations—it's a secure, programmable channel for financial and social innovation. When combined with the onchain capabilities of Base App, builders have a new surface area to build 10X better messaging experiences not currently possible on legacy platforms like WhatsApp or Messenger. - -Real Examples: - -• Smart Payment Assistant: Text "split dinner $200 4 ways" and everyone gets paid instantly with sub-cent fees, no app switching or Venmo delays. - -• AI Trading Companion: Message "buy $100 ETH when it hits $3,000" and your agent executes trades 24/7 while you sleep. - -• Travel Planning Agent: "Book flight LAX to NYC under $300" and get instant booking with crypto payments, all in your group chat - -• Base App & XMTP are combining AI, crypto, and mini apps with secure messaging – to unlock use-cases never before possible. Secure group chats & DMs are the new surface area for developers. diff --git a/docs/docs.json b/docs/docs.json index d57cf57f..eb2a6f75 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -400,7 +400,6 @@ { "group": "Chat Agents", "pages": [ - "base-app/agents/why-agents", "base-app/agents/chat-agents", "base-app/agents/building-quality-agents", "base-app/agents/getting-started", @@ -409,7 +408,6 @@ "base-app/agents/deeplinks", "base-app/agents/x402-agents", "base-app/agents/mini-apps-and-agents", - "base-app/agents/best-practices", "base-app/agents/getting-featured" ] }