Skip to content

Document entry_command field for plugins #447

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.

Sign up for GitHub

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

Open
jpelletier1 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document entry_command field for plugins #447

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa4b2cd
Document entry_command field for plugins
openhands-agent Apr 10, 2026
c3efc1f
Update sdk/guides/plugins.mdx
jpelletier1 Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion sdk/guides/plugins.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
## Plugin Structure

<Note>
See the [example_plugins directory](https://github.com/OpenHands/software-agent-sdk/tree/main/examples/05_skills_and_plugins/02_loading_plugins/example_plugins) for a complete working plugin structure.

Check warning on line 21 in sdk/guides/plugins.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/plugins.mdx#L21 

Did you really mean 'example_plugins'?
</Note>

A plugin follows this directory structure:
Expand Down Expand Up @@ -60,10 +60,13 @@
"description": "Code quality tools and workflows",
"author": "openhands",
"license": "MIT",
"repository": "https://github.com/example/code-quality-plugin"
"repository": "https://github.com/example/code-quality-plugin",
"entry_command": "check"
}
```

The optional `entry_command` field specifies the default command name to invoke when launching the plugin. This should match a command name from the `commands/` directory (e.g., `"check"` for `commands/check.md`). Access it via `plugin.entry_slash_command` which returns the full slash command (e.g., `/code-quality:check`) or `None` if not specified.

### Skills

Skills are defined in markdown files with YAML frontmatter:
Expand Down Expand Up @@ -165,6 +168,10 @@
if plugin.mcp_config:
servers = plugin.mcp_config.get("mcpServers", {})
print(f"MCP servers: {list(servers.keys())}")

# Entry command
if plugin.entry_slash_command:
print(f"Entry command: {plugin.entry_slash_command}")
```
</Step>
<Step>
Expand Down
Loading