Skip to content

docs: document path-triggered rules#606

Merged
rajshah4 merged 3 commits into
mainfrom
vasco/path-triggered-rules-docs
Jul 6, 2026
Merged

docs: document path-triggered rules#606
rajshah4 merged 3 commits into
mainfrom
vasco/path-triggered-rules-docs

Conversation

@VascoSch92

Copy link
Copy Markdown
Member

Why

Reflects software-agent-sdk#3994, which adds path-scoped rules to the SDK's Skill machinery. A rule is a skill with paths: glob frontmatter (a new PathTrigger) whose content is injected deterministically into the tool result when the agent reads/edits/creates a matching file — staying out of <available_skills> and <REPO_CONTEXT> and non-model-invocable, so it adds zero baseline context cost. The docs previously documented only None / KeywordTrigger / TaskTrigger.

Changes

  • overview/skills.mdx — add path-triggered rules to the loading models, the "Skill Types" list, the frontmatter-requirements table, and the cross-reference footer.
  • overview/skills/path.mdx — new conceptual page (modeled on keyword.mdx): usage, paths frontmatter, glob semantics, injection shape, precedence over triggers. Wired into docs.json nav under Skills.
  • sdk/guides/skill.mdx — new Path-Triggered Rules section (Python PathTrigger + file-based example, <EXTRA_INFO> injection shape, glob semantics) plus new rows in the Skill Injection Behavior and Context Loading Methods tables.
  • sdk/arch/skill.mdx — add PathTrigger to the architecture diagram, the Key Components table (linked to the real openhands/sdk/skills/trigger.py), the Trigger Evaluation table, and the frontmatter fields; new Path Skills (Rules) subsection.

Notes

  • Auto-generated/synced surfaces are intentionally left untouched: the SDK API-reference pages (sdk/api-reference/*), openapi/agent-sdk.json, and llms.txt / llms-full.txt (the latter refreshed by the weekly check-llms-files.yml job).
  • Kept as draft pending merge of the upstream SDK PR.

Reflect software-agent-sdk#3994, which adds path-scoped rules — a skill
with `paths:` glob frontmatter (PathTrigger) whose content is injected
deterministically into the tool result when the agent touches a matching
file, staying out of <available_skills>/<REPO_CONTEXT> and non-invocable.

- overview/skills: add path-triggered rules to the loading models, skill
  types list, and frontmatter-requirements table
- overview/skills/path: new conceptual page (frontmatter, glob semantics,
  injection shape), wired into docs.json nav
- sdk/guides/skill: new "Path-Triggered Rules" section plus rows in the
  injection-behavior and context-loading tables
- sdk/arch/skill: add PathTrigger to the diagram, component table, trigger
  evaluation, and frontmatter fields; new "Path Skills (Rules)" subsection
- Render the injected <EXTRA_INFO> exactly as the SDK emits it: the
  "matches ..." and "Follow it ..." sentences are on one line, not two
  (agent_context.get_tool_use_suffix builds them as a single line).
- Architecture diagram: route path rules to a distinct "Tool Result"
  node instead of through Markdown -> Agent Context -> System Prompt.
  Path rules inject into the tool observation and never enter the
  system prompt, so the old edge was misleading.
@VascoSch92 VascoSch92 marked this pull request as ready for review July 6, 2026 08:45
@mintlify

mintlify Bot commented Jul 6, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Jul 6, 2026, 8:50 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@VascoSch92 VascoSch92 force-pushed the vasco/path-triggered-rules-docs branch from f06fbe5 to 8774688 Compare July 6, 2026 09:01
@VascoSch92 VascoSch92 changed the title docs: document path-triggered rules (PathTrigger) docs: document path-triggered rules Jul 6, 2026
@VascoSch92 VascoSch92 closed this Jul 6, 2026
@VascoSch92 VascoSch92 reopened this Jul 6, 2026
Round out overview/skills/creating.mdx with a 'Path Triggers (Rules)'
accordion alongside Keyword/Description triggers, cross-linking the new
path-triggered rules page.
@rajshah4 rajshah4 merged commit c295c1e into main Jul 6, 2026
5 checks passed
@rajshah4 rajshah4 deleted the vasco/path-triggered-rules-docs branch July 6, 2026 19:47
@enyst

enyst commented Jul 6, 2026

Copy link
Copy Markdown
Member

Oops. I didn't realize it will automerge before the actual SDK PR, sorry!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants