Move agent-runtime tips out of SKILL.md into references/#8
Merged
Conversation
Refactor the dbx-ro-query asset's operational notes so SKILL.md stays agent-agnostic and per-runtime quirks live in `<target_dir>/skills/dbx-ro-query/references/agent-<name>.md`. Matches the agentskills.io references/ convention: load the file on demand only when the agent hits a runtime-specific issue, rather than carrying every vendor's quirks inline in the main SKILL.md. Files added: - `references/agent-claude-code.md`: 2-minute Bash tool default timeout (warehouse cold-start hint); exit-code echo pattern reframed for parseable rejection evidence (Claude Code's harness already surfaces non-zero exits to the model, so the echo is only useful for embedding the exit code in captured output text, not for failure detection). - `references/agent-codex.md`: sandbox `network_access = true` setting to unblock GitHub URL fetches and Databricks calls; `login: false` on shell_command for clean captured output (was inline in SKILL.md); warning against PowerShell `Measure-Command` wrappers; warehouse env var note. Validated against a live Codex test session. - `references/agent-cursor.md`: ready-to-paste `.cursor/rules/dbx-ro-query.mdc` rule snippet (Cursor does NOT auto-discover `.cursor/skills/`, only `.cursor/rules/*.mdc`); terminal runtime notes confirming exit codes are surfaced natively; warehouse warm-up note. Validated against a live Cursor 3.3.x / Composer 2 test session. SKILL.md change: the runtime-specific bullet that named Codex inline is replaced with a generic on-demand pointer to the references/ folder. Other operational notes stay generic and apply regardless of runtime. Prevents SKILL.md from drifting toward a multi-vendor compatibility matrix as more agents get documented. success_message change: each per-agent section now points at its references/agent-<name>.md file rather than restating wiring inline. The Cursor section explicitly calls out that `.cursor/skills/` is not auto-discovered, so users see this at install time, not after their first failed query. Asset README troubleshooting: documented two install-time pitfalls surfaced by independent Codex and Cursor test runs. The first is a generic Databricks CLI quirk: `bundle init` fails resolving a stale DATABRICKS_CONFIG_PROFILE; workaround is to re-point the env var at a valid profile. The second is Codex-specific: sandbox blocks the GitHub URL fetch unless network_access = true is set. Test updates: EXPECTED_FILES grows by three (claude-code, codex, cursor); new tests assert SKILL.md points at references/ and every references file starts with an H1 heading so on-demand loaders see a clear scope title. Test count: 2315 -> 2317. Full suite green.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
(no related issue)
Summary
Refactors the
dbx-ro-queryasset's operational notes soSKILL.mdstays agent-agnostic and per-runtime quirks live in<target_dir>/skills/dbx-ro-query/references/agent-<name>.md. Matches the agentskills.ioreferences/convention: the parentSKILL.mdcarries one on-demand pointer; each runtime's quirks live in a sibling file the agent loads only when it hits the relevant issue. PreventsSKILL.mdfrom drifting toward a multi-vendor compatibility matrix as more agents are documented.The
agent-codex.mdandagent-cursor.mdfiles are not speculative: their content was validated by independent Codex and Cursor test sessions running v1.6.0 against a live Databricks workspace, and the findings are folded back in.Changes
references/agent-claude-code.md: 2-minuteBashtool default timeout (warehouse cold-start hint); exit-code echo pattern reframed for parseable rejection evidence (Claude Code's harness already surfaces non-zero exits to the model).references/agent-codex.md: sandboxnetwork_access = truesetting;login: falseonshell_commandfor clean captured output (was inline inSKILL.mdpreviously); PowerShellMeasure-Commandwarning; warehouse env var note. Validated by a live Codex test session.references/agent-cursor.md: ready-to-paste.cursor/rules/dbx-ro-query.mdcrule snippet (Cursor does NOT auto-discover.cursor/skills/); terminal runtime notes confirming exit codes are surfaced natively; warehouse warm-up note. Validated by a live Cursor 3.3.x / Composer 2 test session.SKILL.mdoperational notes: removed the inline Codex bullet; added a single generic line pointing atreferences/agent-<runtime>.md. Other notes remain agent-agnostic.success_message: each per-agent section now points at itsreferences/file rather than restating wiring inline. Cursor section explicitly flags that.cursor/skills/is NOT auto-discovered, so users see this at install time.README.md: new Troubleshooting section documenting (a) the genericDATABRICKS_CONFIG_PROFILEresolution failure both Codex and Cursor reports surfaced, and (b) the Codex-specific sandbox network block.EXPECTED_FILESgrows by three (agent-claude-code.md,agent-codex.md,agent-cursor.md); two new test functions assertSKILL.mdpoints atreferences/and every references file starts with an H1 heading.Change Area
template/, schema, helpers)assets/<name>/)Configuration Axes Affected
databricks_template_schema.json)library/helpers.tmpl)Testing
pytest tests/ -V): 2317 passed, 163 skipped. Asset-only suite: 79 passed in 33s.databricks bundle initagainst a fresh project lays down all 5 expected files (SKILL.md+ script + 3 references) at the correct paths under<target_dir>/skills/dbx-ro-query/. The newsuccess_messagerenders the per-agent pointers exactly as designed.test_skill_references_pointer_present,test_references_files_have_headings.External validation:
SELECT 1scalar,SHOW CATALOGSlines,DESCRIBE samples.nyctaxi.tripstsv,DROP TABLE foorejected exit 1,SELECT 1; DROP TABLE foorejected exit 1). Confirmedlogin: falseadvice is still accurate; identified sandbox network gap; identifiedMeasure-CommandPowerShell pitfall. Findings folded intoreferences/agent-codex.md..cursor/skills/is not auto-discovered and the wiring path is.cursor/rules/*.mdc. Drafted the rule snippet, which is now bundled inreferences/agent-cursor.md. Confirmed exit codes and stdout/stderr are surfaced natively to the model.Asset Changes
databricks bundle init . --template-dir assets/dbx-ro-query --output-dir <dir>.library/helpers.tmplor other assets).tests/configs/assets/dbx_ro_query.jsonalready in place from v1.6.0.Checklist
{{ }}blocks)..tmplfiles appear in generated output.[Unreleased]entries (Added + Changed sections).