skills.rest
datamaker-kr
datamaker-krOFFICIAL
Explore all skills by this author →
WebsiteGitHub

synapse-runtime-context-api

Explain the Synapse RuntimeContext API for logging, progress tracking, and environment access.

1|1|Updated Jan 14, 2026
Search Tags:#api#logging#plugin development#progress tracking#synapse#runtime context
One-click install
npx skills add https://github.com/datamaker-kr/synapse-claude-marketplace --skill synapse-runtime-context-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: synapse-runtime-context-api
Source: https://github.com/datamaker-kr/synapse-claude-marketplace/tree/main/plugins/synapse-plugin-helper/skills/runtime-context-api
Command: npx skills add https://github.com/datamaker-kr/synapse-claude-marketplace --skill synapse-runtime-context-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers understand and effectively utilize the Synapse RuntimeContext API for logging, progress tracking, and accessing environment information within plugin actions.

Core Features & Use Cases

  • Contextual Logging: Log messages, events, and debug information to provide insights into plugin execution.
  • Progress Tracking: Monitor and report the progress of long-running tasks.
  • Metrics Recording: Capture and report performance metrics during execution.
  • Environment Access: Retrieve environment variables and access backend/agent clients.
  • Use Case: When building a complex data processing plugin, use ctx.set_progress to show users the current stage and ctx.log_message to inform them of key events or potential issues.

Quick Start

Use the synapse-runtime-context-api skill to learn how to log messages and track progress in your Synapse plugin actions.

Frequently Asked Questions about synapse-runtime-context-api

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

FAQPage Schema
How do I log user-facing messages in Synapse plugin actions?▼

To log user-facing messages in Synapse plugin actions, use the RuntimeContext API method `ctx.log_message` to record events, debug information, and contextual insights during plugin execution.

What is the best way to track progress of long-running tasks in a Synapse plugin?▼

Track progress of long-running tasks in a Synapse plugin by calling the `ctx.set_progress` method from the RuntimeContext API to monitor and report current execution stages to users.

Can I access environment variables and backend clients within Synapse plugin actions?▼

Yes, you can access environment variables and retrieve backend or agent clients within Synapse plugin actions by utilizing the environment access capabilities provided by the RuntimeContext API.

How do I record performance metrics during Synapse plugin execution?▼

Record performance metrics during Synapse plugin execution by using the RuntimeContext API to capture and report specific performance data points throughout the action's lifecycle.

Does RuntimeContext API work with complex data processing plugins in Synapse?▼

Yes, the RuntimeContext API works with complex data processing plugins in Synapse, allowing developers to combine `ctx.set_progress` for stage updates and `ctx.log_message` to inform users of key events.

Why am I unable to report job-specific details in my Synapse plugin?▼

You are unable to report job-specific details because you are not accessing them through the Synapse RuntimeContext API, which provides dedicated methods for retrieving job-specific environment information.

Related Skills

Explore More Software Engineering Skills→
Reign-softwareReign-software

hytale-env-setup

Set up a Hytale plugin development environment with JDK 25 and Gradle.

Official
Intermediate
datamaker-krdatamaker-kr
1

synapse-config-yaml-guide

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

Official
Intermediate
Vincentwei1021Vincentwei1021
29

sessions

Diagnose Synapse Claude Code plugin session lifecycle issues by mapping hooks to state changes.

Community
Intermediate
perfectuser21perfectuser21

repo-lead

Coordinate AI script and LLM employees to achieve OKRs via the Brain API.

Community
Advanced