docs: Update plugin loading documentation for Conversation-based approach#265
Draft
jpshackelford wants to merge 4 commits intomainfrom
Draft
docs: Update plugin loading documentation for Conversation-based approach#265jpshackelford wants to merge 4 commits intomainfrom
jpshackelford wants to merge 4 commits intomainfrom
Conversation
Add documentation for the recommended pattern of loading plugins via AgentContext.plugin_source. This pattern: - Is consistent with the agent-server API - Automatically handles all plugin components (skills, MCP config, hooks) - Reduces boilerplate code The existing Plugin.load() pattern is now documented as 'Manual Plugin Loading' for advanced use cases requiring fine-grained control. Related to: OpenHands/software-agent-sdk#1651 Co-authored-by: openhands <openhands@all-hands.dev>
Updates documentation to reflect the actual implementation: - Plugin loading via `plugins` parameter on Conversation - Using PluginSource model instead of AgentContext fields - Updated example path to 03_plugin_via_conversation Related: OpenHands/software-agent-sdk#1651 Co-authored-by: openhands <openhands@all-hands.dev>
- Replace verbose inline examples with concise code snippets - Add proper prose sections for plugin source formats - Add sections for multiple plugins, remote conversations - Simplify manual loading section - Remove redundant embedded full example code Co-authored-by: openhands <openhands@all-hands.dev>
Update documentation to reflect that plugins are loaded lazily on first send_message() or run() call, not when the Conversation is created. Related: OpenHands/software-agent-sdk#1651 Co-authored-by: openhands <openhands@all-hands.dev>
|
Looks like there are a few issues preventing this PR from being merged!
If you'd like me to help, just leave a comment, like Feel free to include any additional details that might help me get this PR into a better state. You can manage your notification settings |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Update documentation to reflect the actual plugin loading implementation in software-agent-sdk#1651.
Changes
pluginsparameter onConversation(notAgentContext.plugin_source)PluginSourcemodel for specifying plugins03_plugin_via_agent_contextto03_plugin_via_conversationThe Recommended Pattern
Related