Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: Update plugin loading documentation for Conversation-based approach#265

Draft
jpshackelford wants to merge 4 commits intomain from
feat/plugin-via-agent-context-example
Draft

docs: Update plugin loading documentation for Conversation-based approach #265
jpshackelford wants to merge 4 commits intomain from
feat/plugin-via-agent-context-example

Conversation

@jpshackelford
Copy link
Contributor

@jpshackelford jpshackelford commented Jan 18, 2026
edited
Loading

Summary

Update documentation to reflect the actual plugin loading implementation in software-agent-sdk#1651.

Changes

  • Update "Recommended" section to use plugins parameter on Conversation (not AgentContext.plugin_source)
  • Use PluginSource model for specifying plugins
  • Update example path from 03_plugin_via_agent_context to 03_plugin_via_conversation
  • Update Quick Reference section
  • Fix anchor link in Manual Plugin Loading note

The Recommended Pattern

from openhands.sdk.plugin import PluginSource
conversation = Conversation(
 agent=agent,
 workspace="./workspace",
 plugins=[
 PluginSource(source="github:org/security-plugin", ref="v2.0.0"),
 PluginSource(source="github:org/monorepo", repo_path="plugins/audit"),
 PluginSource(source="/local/custom-plugin"),
 ],
)

Related

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>
@jpshackelford jpshackelford changed the title (削除) docs: Add plugin loading via AgentContext example (削除ここまで) (追記) docs: Update plugin loading documentation for Conversation-based approach (追記ここまで) Jan 20, 2026
- 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>
Copy link

openhands-ai bot commented Jan 21, 2026

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • .github/workflows/sync-docs-code-blocks.yml
    • .github/workflows/sync-agent-sdk-openapi.yml

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #265 at branch `feat/plugin-via-agent-context-example`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

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

Reviewers

@xingyaoww xingyaoww Awaiting requested review from xingyaoww xingyaoww will be requested when the pull request is marked ready for review xingyaoww is a code owner

@enyst enyst Awaiting requested review from enyst enyst will be requested when the pull request is marked ready for review enyst is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Comments

AltStyle によって変換されたページ (->オリジナル) /