Skip to content

docs(skill-development): add allowed-tools optional frontmatter documentation#42

Merged
sjnims merged 1 commit intomainfrom
docs/39-add-allowed-tools-documentation
Dec 8, 2025
Merged

docs(skill-development): add allowed-tools optional frontmatter documentation#42
sjnims merged 1 commit intomainfrom
docs/39-add-allowed-tools-documentation

Conversation

@sjnims
Copy link
Owner

@sjnims sjnims commented Dec 8, 2025

Summary

Add documentation for the optional allowed-tools frontmatter field that allows skills to restrict which tools Claude can use when the skill is active.

Problem

Fixes #39

The official Claude Code documentation includes an allowed-tools frontmatter field for skills, but the skill-development skill didn't document this optional feature. Users creating skills didn't know about this option for restricting tool access.

Solution

Added documentation to SKILL.md explaining the allowed-tools feature:

  • New "Optional Frontmatter Fields" section after "SKILL.md (required)"
  • YAML example showing proper syntax
  • Use cases (read-only skills, security-sensitive workflows, limited scope)
  • Updated validation checklist with optional allowed-tools check

Alternatives Considered

  1. Add to references file - Rejected because this is a core frontmatter feature that belongs in the main SKILL.md, not detailed reference material
  2. Just link to official docs - Rejected because external links may break and doesn't provide enough context

Changes

  • plugins/plugin-dev/skills/skill-development/SKILL.md: +23 lines
    • Added "Optional Frontmatter Fields" section with allowed-tools documentation
    • Added optional check in validation checklist

Testing

  • Linting passes (markdownlint)
  • Documentation follows existing patterns
  • Example uses correct YAML syntax

🤖 Generated with Claude Code

…entation

Add documentation for the optional `allowed-tools` frontmatter field that allows
skills to restrict which tools Claude can use when the skill is active. This is
useful for read-only skills, security-sensitive workflows, and skills with limited
scope.

Changes:
- Add "Optional Frontmatter Fields" section with allowed-tools documentation
- Include YAML example showing proper syntax
- List use cases for tool restriction
- Update validation checklist with optional allowed-tools check

Fixes #39

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@claude
Copy link

claude bot commented Dec 8, 2025

Claude finished @sjnims's task —— View job


PR Review Complete ✓

Reviewing PR #42: docs(skill-development): add allowed-tools optional frontmatter documentation


Summary

✅ Looks good - This PR properly documents the allowed-tools optional frontmatter field with clear examples and appropriate placement.


What's Good

  1. Perfect Placement: The new "Optional Frontmatter Fields" section is positioned logically right after the required SKILL.md section, making it easy to find.

  2. Clear Documentation: The explanation is concise and well-structured:

    • Shows correct YAML syntax with a realistic example (code-reviewer)
    • Lists three specific use cases (read-only skills, security-sensitive workflows, limited scope)
    • Explains the behavior clearly (tools available without permission vs. standard permission model)
  3. Complete Integration: The validation checklist was properly updated with an optional check for allowed-tools, maintaining consistency throughout the document.

  4. Markdown Quality: All markdown linting passes cleanly - proper formatting, consistent style.

  5. Addresses the Gap: Fixes issue docs(skill-development): add allowed-tools optional frontmatter documentation #39 by documenting a feature that exists in the official Claude Code documentation but was missing from the skill-development guidance.


Suggestions

None - this is a straightforward documentation addition that follows existing patterns and doesn't require any changes.


Checklist Verification

  • Skills component: Properly documents optional frontmatter field with correct YAML syntax
  • Markdown linting: Passes markdownlint with no errors
  • Documentation: Updates validation checklist to include the new optional field
  • Writing style: Follows imperative voice and existing documentation patterns
  • Progressive disclosure: Keeps the addition focused and lean (23 lines)

Recommendation: Approve and merge. This PR successfully documents the allowed-tools feature without introducing any issues.


@sjnims sjnims self-assigned this Dec 8, 2025
@claude claude bot added documentation Improvements or additions to documentation component:skill Skills layer effort:small < 1 hour labels Dec 8, 2025
@sjnims sjnims merged commit 889e080 into main Dec 8, 2025
8 checks passed
@sjnims sjnims deleted the docs/39-add-allowed-tools-documentation branch December 8, 2025 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:skill Skills layer documentation Improvements or additions to documentation effort:small < 1 hour

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(skill-development): add allowed-tools optional frontmatter documentation

1 participant