README

Splash Skills

Agent Skills for building Splash Sync connectors.

A skill is a folder with a SKILL.md (frontmatter name + description, then concise instructions) and references/ files loaded on demand. AI coding agents read the description to decide when to activate the skill, then follow it: rules, workflow, and pointers to the exhaustive documentation shipped in the splash/* packages.

The format follows the open Agent Skills specification and works with Claude Code, Cursor, GitHub Copilot, OpenAI Codex, Gemini CLI, Mistral Vibe, Windsurf and any agent supporting it.

Skills

Skill	Purpose
`splash-connector`	Build, extend and package generation 3 Splash connectors: metadata mapping, field templates & scopes, objects & CRUD, connector configuration & forms, OAuth2, Toolkit / Validator testing, `.splx` bridge workers, code quality.

Install

Claude Code — as a plugin from this marketplace:

/plugin marketplace add SplashTools/skills
/plugin install splash-connector@splashsync

Any agent supporting Agent Skills — copy (or install with your agent's skills tool) the skills/splash-connector/ folder into your agent skills directory, e.g. .claude/skills/, .agents/skills/, .cursor/skills/, .codex/skills/. The folder is self-contained.

Splash Toolkit MCP server — when splash/skills is installed next to the Toolkit, skills are served as splash://skills/* resources: any agent connected to the Toolkit can read them without installing anything.

Composer — composer require --dev splash/skills (pulled by splash/toolkit) makes the skill files available under vendor/splash/skills/ for tooling and lint.

In a connector repository

Drop the two pointer files from templates/connector/ at the root of the connector: AGENTS.md (read by Codex, Cursor, Copilot, Gemini, Jules...) and CLAUDE.md (Claude Code, which imports AGENTS.md). They only say where the skill is and how to get it.

Documentation strategy

The skill holds rules, decisions, constraints and skeletons. The exhaustive reference stays in the package docs, referenced three ways in priority order:

local path in the connector vendor/ (vendor/splash/<package>/docs/..., offline, versioned with the installed package),
MCP resource (splash://docs/...) when the Toolkit MCP server is connected,
web url on gitlab.com (fallback).

bin/skills-lint verifies that every local path referenced by the skills exists in the packages declared in require-dev; the CI runs it on every push.

Contributing

Skill and docs are written in English.
Never duplicate a rule that a package documents: state it briefly and point to the source.
Keep SKILL.md short (rules + map); put details in references/.
Run composer install && composer lint before opening a merge request.

License

MIT - See LICENSE

splash / skills

Package info

Security

Statistics