Document append-only skill context#259
Conversation
Fixes ARPAHLS#258 Assisted-by: Claude Code
rosspeili
left a comment
rosspeili
left a comment
There was a problem hiding this comment.
Hey @Dodothereal, thanks for taking the time to address this. As you're a first time contributor, I will accept this with some minor tweaks, and please comment on the original issue so you can be assigned to it.
For future PRs, please try to browse issues, and claim them before opening PRs. This looks clean and focused overall, well done <3
| - Categories: `compliance`, `creative`, `data_engineering`, `defi`, `dev_tools`, `finance`, `monitoring`, `office`, `optimization`, `wellness` — see [Skill library](../skills/README.md) for the live registry; [Choosing a category](../../CONTRIBUTING.md#choosing-a-category) in CONTRIBUTING.md (issue first for new top-level folders) | ||
| - Do not bump `pyproject.toml` version in skill-only PRs unless requested | ||
| - Logic in `skill.py`; prompts and persona in `instructions.md` | ||
| - Logic in `skill.py`; skill-specific context in `instructions.md`. Keep instructions short and append-only: host agents already own their system prompt and persona, so describe this skill's use, limits, outputs, and errors instead of assigning a role. |
There was a problem hiding this comment.
host agents might already inherit system prompts and persona beyond Skillware
| @@ -1,14 +1,20 @@ | |||
| # Instructions: My Awesome Skill | |||
| # My Awesome Skill (`category/my_awesome_skill`) | |||
There was a problem hiding this comment.
Instructions for using My Awesome Skill ('cateogory/my_awesome_skill')
| # My Awesome Skill (`category/my_awesome_skill`) | ||
|
|
||
| You are an agent equipped with the **My Awesome Skill**. | ||
| [Describe what this skill does, whether it is local or deterministic, and important limits.] |
There was a problem hiding this comment.
I would keep the old line, or if you wanna keep it: Describe what this skill does, eg. You are equipped with My Awesome Skill...
| - Use this tool when the user asks for [describe primary use case]. | ||
| - Do not use this tool for [describe anti-patterns]. | ||
|
|
||
| ### How to use this tool |
There was a problem hiding this comment.
Need a better way to make it broad. See how skills work now. In most cases knowing which function to call and when is enough. Write it in a way that would help new skill creators to get an idea and adjust it to their skill.
| ### How to interpret the output | ||
| - The tool returns a `result` field containing [describe result]. | ||
| - If you see an error message, explain to the user that [describe error handling]. | ||
| - If you see an error message, [describe the host's next step]. |
There was a problem hiding this comment.
We can leave this as was, no need to restate avoiding using persona, already above.
|
Thank you for the review and guidance. I have commented on the original issue to claim it, and I will browse and claim issues before opening future PRs. |
2 participants
Document append-only skill context
Summary
Clarifies that skill
instructions.mdfiles are concise, append-only skill-context blocks rather than host-agent persona prompts. The guidance preserves contributor flexibility while helping multiple skills coexist in a host agent's context.Fixes #258
Changes
instructions.mdcontributor guidance around skill purpose, limits, inputs, outputs, and errors.Testing
sandbox-run "python -m pytest tests/test_registry_docs.py"— passed: 7 tests.sandbox-run "pip install -e '.[dev]' && python -m flake8"— passed.git diff --check— passed.sandbox-run "pip install -e '.[dev]' && python -m black --check CONTRIBUTING.md docs/contributing/ai_native_workflow.md templates/python_skill/instructions.md CHANGELOG.md && python -m flake8"— not applicable as written: Black was invoked on Markdown files and reported parse errors before Flake8 ran; the standalone Flake8 command above passed.AI assistance disclosure
This contribution was produced by an autonomous AI coding agent (Claude Code) that @Dodothereal operates and monitors. @Dodothereal is accountable for it, will address review feedback promptly, and will close this PR immediately if this kind of contribution is unwelcome in this project. Commits carry an
Assisted-by: Claude Codetrailer.