Skip to content

Commit 4ac66c4

Browse files
sjnimsclaude
andauthored
docs: update tools field examples to comma-separated format (#134)
## Summary Updates the agent-development skill documentation to use comma-separated format for the `tools` field instead of array format, aligning with official Claude Code documentation. ## Problem Fixes #132 The documentation examples showed array format (`tools: ["Read", "Write"]`) while official Claude Code docs use comma-separated format (`tools: Read, Write`). This inconsistency could confuse users creating agents. ## Solution Updated all `tools` field examples to use comma-separated format to match: - Official [sub-agents.md](https://docs.claude.com/en/docs/claude-code/sub-agents) documentation - Existing agents in this plugin (`plugin-validator.md`, `skill-reviewer.md`, `agent-creator.md`) ### Alternatives Considered - **Leave as array format**: Rejected because it contradicts official documentation - **Support both formats**: Not applicable - this is documentation only, not code ## Changes - `SKILL.md:116` - Complete Format example - `SKILL.md:228-231` - tools field format description and code block - `SKILL.md:238-242` - Common tool sets section - `SKILL.md:441` - Frontmatter Fields Summary table ## Testing - [x] Markdownlint passes - [x] Changes are documentation-only (no functional impact) - [x] Format matches official documentation --- 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <noreply@anthropic.com>
1 parent 5daa19e commit 4ac66c4

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

  • plugins/plugin-dev/skills/agent-development

plugins/plugin-dev/skills/agent-development/SKILL.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ assistant: "[How assistant should respond and use this agent]"
113113

114114
model: inherit
115115
color: blue
116-
tools: ["Read", "Write", "Grep"]
116+
tools: Read, Write, Grep
117117
---
118118

119119
You are [agent role description]...
@@ -225,21 +225,21 @@ Visual identifier for agent in UI.
225225

226226
Restrict agent to specific tools.
227227

228-
**Format:** Array of tool names
228+
**Format:** Comma-separated tool names
229229

230230
```yaml
231-
tools: ["Read", "Write", "Grep", "Bash"]
231+
tools: Read, Write, Grep, Bash
232232
```
233233
234234
**Default:** If omitted, agent has access to all tools
235235
236236
**Best practice:** Limit tools to minimum needed (principle of least privilege)
237237
238238
**Common tool sets:**
239-
- Read-only analysis: `["Read", "Grep", "Glob"]`
240-
- Code generation: `["Read", "Write", "Grep"]`
241-
- Testing: `["Read", "Bash", "Grep"]`
242-
- Full access: Omit field or use `["*"]`
239+
- Read-only analysis: `Read, Grep, Glob`
240+
- Code generation: `Read, Write, Grep`
241+
- Testing: `Read, Bash, Grep`
242+
- Full access: Omit field entirely
243243

244244
> **Important:** Agents use `tools` while Skills use `allowed-tools`. The field names differ between component types. For skill tool restrictions, see the `skill-development` skill.
245245

@@ -438,7 +438,7 @@ Output: [What to provide]
438438
| description | Yes | Text + examples | Use when... <example>... |
439439
| model | Yes | inherit/sonnet/opus/haiku | inherit |
440440
| color | Yes | Color name | blue |
441-
| tools | No | Array of tool names | ["Read", "Grep"] |
441+
| tools | No | Comma-separated tool names | Read, Grep |
442442

443443
> **Note:** Agents use `tools` to restrict tool access. Skills use `allowed-tools` for the same purpose. The field names differ between component types.
444444

0 commit comments

Comments
 (0)