Skip to content

docs: add dynamic command execution for skills#426

Merged
VascoSch92 merged 4 commits intomainfrom
docs/skills-dynamic-command-execution
Apr 5, 2026
Merged

docs: add dynamic command execution for skills#426
VascoSch92 merged 4 commits intomainfrom
docs/skills-dynamic-command-execution

Conversation

@VascoSch92
Copy link
Copy Markdown
Contributor

@VascoSch92 VascoSch92 commented Mar 31, 2026

Summary

Document the new inline shell command execution feature (!command`` syntax) for skills that enables dynamic context injection at render time.

This PR adds documentation for the feature introduced in OpenHands/software-agent-sdk#2582.

Changes

SDK Skills Guide (sdk/guides/skill.mdx)

  • Added new "Dynamic Command Execution" section covering:
    • Basic !command`` syntax with examples
    • Safety rules (code blocks are never executed)
    • Escape syntax (\!cmd``) for documenting the syntax itself
    • Error handling (failures, timeouts, truncation)
    • Programmatic render_content() method usage
    • Security warning about command execution privileges

Skill Architecture (sdk/arch/skill.mdx)

  • Added "Dynamic Content Rendering" to core responsibilities
  • Added render_content_with_commands to key components table
  • Added new "Dynamic Content Rendering" section with flow diagram
  • Updated main architecture diagram to include dynamic commands
  • Updated skill file format example to show dynamic values

Related PR

@openhands-agent
docs: add dynamic command execution for skills
99299bc 
Document the new inline shell command execution feature (! syntax)
for skills that enables dynamic context injection at render time.

- Add 'Dynamic Command Execution' section to SDK skills guide
- Update skill architecture with Dynamic Content Rendering capability
- Update architecture diagram to show dynamic commands flow
- Add render_content_with_commands to key components table

Related to: OpenHands/software-agent-sdk#2582

Co-authored-by: openhands <openhands@all-hands.dev>
@VascoSch92 VascoSch92 mentioned this pull request Mar 31, 2026
Merged
5 tasks
all-hands-bot

This comment was marked as outdated.

Sign in to view

@mintlify
Copy link
Copy Markdown

mintlify bot commented Mar 31, 2026 •
edited
Loading

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Mar 31, 2026, 10:32 AM

all-hands-bot
all-hands-bot approved these changes Mar 31, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taste Rating: 🟢 Good taste - Documentation is technically accurate and well-structured. Verified all details against SDK PR #2582 implementation.

@VascoSch92 VascoSch92 marked this pull request as ready for review April 3, 2026 18:50
all-hands-bot
all-hands-bot approved these changes Apr 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taste Rating: 🟢 Good taste - Documentation accurately reflects the implementation (verified against merged SDK PR #2582). Security warning properly placed, examples are practical and runnable, previous feedback addressed. Clean technical writing.

xingyaoww
xingyaoww approved these changes Apr 5, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@xingyaoww xingyaoww left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Though i realize this file probably becomes way too long that we should consider break it into multiple smaller file at some point 😭

@VascoSch92 VascoSch92 merged commit c0a2610 into main Apr 5, 2026
9 checks passed
@VascoSch92 VascoSch92 deleted the docs/skills-dynamic-command-execution branch April 5, 2026 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xingyaoww xingyaoww xingyaoww approved these changes

@all-hands-bot all-hands-bot all-hands-bot approved these changes

@enyst enyst Awaiting requested review from enyst enyst is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@VascoSch92 @xingyaoww @all-hands-bot @openhands-agent