Conversation
Add a dedicated SDK guide for examples/01_standalone_sdk/46_agent_settings.py and register it in the SDK navigation so the documented-examples check can find it. Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
Documentation content is accurate and well-written. Minor metadata issue: the referenced SDK PR #2661 is about GitHub Actions, not AgentSettings.
| @@ -0,0 +1,179 @@ | |||
| --- | |||
There was a problem hiding this comment.
🟡 Suggestion - PR Reference: The PR description references SDK PR #2661 which is about bumping actions/checkout, not AgentSettings. Since the example file 46_agent_settings.py already exists in the SDK main branch, this is accurate documentation and can be merged. Consider updating the PR description to clarify that the SDK example is already merged, or reference the correct SDK PR that added it.
The branch name dependabot/github_actions/actions/checkout-6 is also confusing since it suggests a Dependabot PR, but this doesn't block the merge.
| > A ready-to-run example is available [here](#ready-to-run-example)! | ||
|
|
||
| `AgentSettings` gives you a structured, serializable way to define an agent's model, tools, and optional subsystems like the condenser. Use it when you want to store agent configuration in JSON, send it over an API, or rebuild agents from validated settings later. | ||
|
|
There was a problem hiding this comment.
✅ Verified Accurate: Confirmed AgentSettings exists in SDK with correct fields (llm, tools, condenser) and the create_agent() method.
| Tool(name=TerminalTool.name), | ||
| Tool(name=FileEditorTool.name), | ||
| ], | ||
| condenser=CondenserSettings(enabled=True, max_size=50), |
There was a problem hiding this comment.
✅ Verified Accurate: CondenserSettings has enabled (bool) and max_size (int) fields. The example value of 50 is valid (minimum is 20, default is 240).
| This example is available on GitHub: [examples/01_standalone_sdk/46_agent_settings.py](https://github.com/OpenHands/software-agent-sdk/blob/main/examples/01_standalone_sdk/46_agent_settings.py) | ||
| </Note> | ||
|
|
||
| ```python icon="python" expandable examples/01_standalone_sdk/46_agent_settings.py |
There was a problem hiding this comment.
✅ Code Sync Format Correct: The code block format python icon="python" expandable examples/01_standalone_sdk/46_agent_settings.py is correct for automatic code synchronization.
2 participants
Summary
examples/01_standalone_sdk/46_agent_settings.pydocs.jsoncheck-documented-examplescan pick it up on rerunValidation
DOCS_PATH=/workspace/project/docs python .github/scripts/check_documented_examples.pyfromsoftware-agent-sdkRelated to OpenHands/software-agent-sdk#2661.
This PR was created by an AI assistant (OpenHands) on behalf of @enyst.
@enyst can click here to continue refining the PR