summaryrefslogtreecommitdiff
path: root/plugins/example-plugin/README.md
blob: 34d9c2a0eaef863c3da9ec0ada97ea53942c351f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# Example Plugin

A comprehensive example plugin demonstrating Claude Code extension options.

## Structure

```
example-plugin/
├── .claude-plugin/
│   └── plugin.json        # Plugin metadata
├── .mcp.json              # MCP server configuration
├── commands/
│   └── example-command.md # Slash command definition
└── skills/
    └── example-skill/
        └── SKILL.md       # Skill definition
```

## Extension Options

### Commands (`commands/`)

Slash commands are user-invoked via `/command-name`. Define them as markdown files with frontmatter:

```yaml
---
description: Short description for /help
argument-hint: <arg1> [optional-arg]
allowed-tools: [Read, Glob, Grep]
---
```

### Skills (`skills/`)

Skills are model-invoked capabilities. Create a `SKILL.md` in a subdirectory:

```yaml
---
name: skill-name
description: Trigger conditions for this skill
version: 1.0.0
---
```

### MCP Servers (`.mcp.json`)

Configure external tool integration via Model Context Protocol:

```json
{
  "server-name": {
    "type": "http",
    "url": "https://mcp.example.com/api"
  }
}
```

## Usage

- `/example-command [args]` - Run the example slash command
- The example skill activates based on task context
- The example MCP activates based on task context