Explains how to write Synapse plugin config.yaml files. Use when the user asks about "config.yaml", "plugin configuration", "action definition", "execution method", "runtime environment", or needs help with synapse plugin settings.
npx claudepluginhub datamaker-kr/synapse-claude-marketplace --plugin synapse-plugin-helperThis skill uses the workspace's default tool permissions.
The `config.yaml` file (or `synapse.yaml`) defines your plugin's metadata, actions, and runtime configuration.
Searches, retrieves, and installs Agent Skills from prompts.chat registry using MCP tools like search_skills and get_skill. Activates for finding skills, browsing catalogs, or extending Claude.
Searches prompts.chat for AI prompt templates by keyword or category, retrieves by ID with variable handling, and improves prompts via AI. Use for discovering or enhancing prompts.
Guides MCP server integration in Claude Code plugins via .mcp.json or plugin.json configs for stdio, SSE, HTTP types, enabling external services as tools.
The config.yaml file (or synapse.yaml) defines your plugin's metadata, actions, and runtime configuration.
name: "My Plugin"
code: my-plugin
version: 1.0.0
category: custom
actions:
train:
entrypoint: plugin.train:TrainAction
method: job
description: "Train a model"
# Basic metadata
name: "YOLOv8 Object Detection"
code: yolov8
version: 1.0.0
category: neural_net
description: "Train and run YOLOv8 models"
readme: README.md
# Package management
package_manager: pip # or 'uv'
package_manager_options: []
wheels_dir: wheels
# Environment variables
env:
DEBUG: "false"
BATCH_SIZE: "32"
# Runtime environment (Ray)
runtime_env: {}
# Data type configuration
data_type: image
tasks:
- image.object_detection
- image.segmentation
# Actions
actions:
train:
entrypoint: plugin.train:TrainAction
method: job
description: "Train YOLO model"
inference:
entrypoint: plugin.inference:run
method: task
description: "Run inference"
| Field | Required | Description |
|---|---|---|
entrypoint | Yes | Module path (module.path:ClassName or module.path.function) |
method | No | Execution method: job, task, or serve (default: task) |
description | No | Human-readable description |
Config Sync (Recommended)
Sync entrypoints, input/output types, and hyperparameters from code:
synapse plugin update-config
| Method | Use Case | Characteristics |
|---|---|---|
job | Training, batch processing | Async, isolated, long-running (100s+) |
task | Interactive operations | Sync, fast startup (<1s), serial per actor |
serve | Model serving, inference | REST API endpoint, auto-scaling |
Both formats are supported:
plugin.train:TrainActionplugin.train.TrainActionFor detailed configuration options: