-
Notifications
You must be signed in to change notification settings - Fork 1
Add new Agent IO instructions, tutorial/guide #265
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| --- | ||
| title: Agent Input and Output | ||
| description: How to handle agent input and output | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| Agent IO enables your agents to communicate with external platforms through two types of connections: Sources (inbound) and Destinations (outbound). Understanding the distinction between these connection types is essential for properly configuring your AI agents on the Agentuity platform. | ||
|
|
||
| ## Sources vs Destinations | ||
|
|
||
| ### Sources (Inbound Connections) | ||
|
|
||
| Sources enable bidirectional communication between a platform and your agent. When configured, the platform can trigger your agent and receive responses within the same conversation context. | ||
|
|
||
| **How Sources Work:** | ||
| 1. Platform triggers agent (e.g., @mention in Slack) | ||
| 2. Agent processes the request | ||
| 3. Agent responds directly within the same platform conversation | ||
|
|
||
| **Example:** When someone @mentions your agent in Discord, the agent can respond back in the same Discord channel. | ||
|
|
||
| ### Destinations (Outbound Connections) | ||
|
|
||
| Destinations allow your agent to send messages to a platform when triggered by *external sources*. These are one-way connections for delivering agent output to specified channels. | ||
|
|
||
| **How Destinations Work:** | ||
| 1. External source triggers agent (webhook, API, schedule, etc.) | ||
| 2. Agent processes the request | ||
| 3. Agent sends output to configured destination platforms | ||
|
|
||
| **Example:** Your GitHub repository triggers your agent on each commit, and the agent sends a formatted summary to your team's Discord channel. | ||
|
|
||
| ## Choosing Your Configuration | ||
|
|
||
| | Use Case | Configuration Needed | | ||
| |---------------------|---------------------| | ||
| | Chat bot that responds to @mentions | **Source only** | | ||
| | Send notifications when something happens | **Destination only** | | ||
| | Forward messages between platforms | **Source** for receiving, **Destination** for sending | | ||
| | Full assistant with chat and notifications | **Both** Source and Destination | | ||
|
|
||
| ### Sources Only | ||
| Perfect for conversational bots that respond to user questions, @mentions, or direct messages. | ||
|
|
||
| **Example:** Your team wants a Slack bot that answers questions about your documentation. You only need a Slack Source - users @mention the bot, and it replies in the thread. | ||
|
|
||
| ### Destinations Only | ||
| Ideal for automated notifications, scheduled updates, or forwarding alerts from monitoring systems. | ||
|
|
||
| **Example:** You want GitHub commit notifications in Discord. Configure a webhook to trigger your agent, then add Discord as a Destination. No Discord Source needed since the bot doesn't respond to Discord messages. | ||
|
|
||
| ### Both Sources and Destinations | ||
| Required when your agent needs conversations AND notifications, connecting multiple platforms, or building a full-featured assistant. | ||
|
|
||
| **Example:** You're building a team assistant that answers questions in Slack (Source) but also posts daily standup reminders (Destination) and forwards important emails to the channel (Email Source → Slack Destination). | ||
|
|
||
| ## Key Considerations | ||
|
|
||
| - **Sources** provide complete conversational capability - you don't need a destination to reply | ||
| - **Destinations** work independently - perfect for one-way notifications | ||
| - A single agent can have multiple sources and destinations configured | ||
|
|
||
| ## Video Tutorials | ||
|
|
||
| {/* ### Configuring Slack Inbound | ||
| <iframe | ||
| width="100%" | ||
| height="400" | ||
| src="SLACK_INBOUND_VIDEO_URL_PLACEHOLDER" | ||
| title="Setting up Slack Source Integration" | ||
| frameBorder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" | ||
| allowFullScreen | ||
| ></iframe> */} | ||
|
|
||
| ### Discord Destination Setup | ||
| <iframe | ||
| width="100%" | ||
| height="400" | ||
| src="https://www.youtube.com/embed/1t22ExfvjSY" | ||
| title="Introducing Discord destinations" | ||
| frameBorder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" | ||
| allowFullScreen | ||
| ></iframe> | ||
|
|
||
| ### Email Destination Configuration | ||
| <iframe | ||
| width="100%" | ||
| height="400" | ||
| src="https://www.youtube.com/embed/X-HEUFH5C0Y" | ||
| title="Introducing email destinations" | ||
| frameBorder="0" | ||
| allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" | ||
| allowFullScreen | ||
| ></iframe> | ||
|
|
||
| ## Next Steps | ||
|
|
||
| - Review the [Agents](/Cloud/agents) documentation for platform-specific configuration | ||
| - Configure *sources* for platforms where users will interact with your agent | ||
| - Set up *destinations* for platforms where your agent will send notifications |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Remove/adjust API response text under Email Source
Email sources aren’t invoked via API; this note is misleading.
📝 Committable suggestion
🤖 Prompt for AI Agents
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good one
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jhaynie Thank you! I'm glad the correction was helpful. It's important to keep the documentation accurate, especially when describing how different source types work - email sources being triggered by incoming emails rather than API calls is a key distinction for users to understand.
🐰✨ hops excitedly