synapse-config-yaml-guide

Guide creation of Synapse plugin config.yaml files with metadata, actions, and runtime settings.

1|1|Updated Jan 14, 2026
One-click install
npx skills add https://github.com/datamaker-kr/synapse-claude-marketplace --skill synapse-config-yaml-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: synapse-config-yaml-guide
Source: https://github.com/datamaker-kr/synapse-claude-marketplace/tree/main/plugins/synapse-plugin-helper/skills/config-yaml-guide
Command: npx skills add https://github.com/datamaker-kr/synapse-claude-marketplace --skill synapse-config-yaml-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance on writing and understanding config.yaml files, enabling users to effectively configure their Synapse plugins.

Core Features & Use Cases

  • config.yaml Structure: Explains the basic and complete structure of the configuration file.
  • Action Configuration: Details the fields required for defining plugin actions, including entrypoint, method, and description.
  • Execution Methods: Clarifies the differences and use cases for job, task, and serve execution methods.
  • Use Case: A developer needs to define a new action for their Synapse plugin that performs model training. They consult this Skill to understand how to correctly specify the entrypoint, method, and other necessary parameters in their config.yaml.

Quick Start

Consult the config.yaml guide for details on writing Synapse plugin configuration files.

Frequently Asked Questions about synapse-config-yaml-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure a Synapse plugin config.yaml file?

To configure a Synapse plugin config.yaml file, you define metadata, actions, and runtime configurations. The file requires specific fields like entrypoint, method, and description to establish plugin behavior and integration within the Synapse ecosystem.

What is the difference between job, task, and serve execution methods in Synapse?

Job, task, and serve are distinct execution methods in Synapse for defining plugin actions. The config.yaml guide clarifies their specific differences and use cases to help you specify the correct method for your plugin's runtime behavior.

What fields are required for action definition in a Synapse config.yaml?

Required fields for action definition in a Synapse config.yaml include entrypoint, method, and description. These fields specify how the plugin action executes and integrates within the Synapse ecosystem.

Can I configure package management and environment variables in Synapse config.yaml?

Yes, you can configure package management and environment variables in Synapse config.yaml. The file supports optional fields specifically for managing package dependencies and setting environment variables during plugin runtime.

How do I specify an entrypoint for model training in a Synapse plugin?

To specify an entrypoint for model training in a Synapse plugin, you define the action in your config.yaml file. You must correctly specify the entrypoint, method, and necessary parameters to configure the training behavior.