HexaSync Template IDE
Build HexaSync profile templates faster, in VS Code and with your AI coding agent.
- In the editor: IntelliSense and hover docs for every component and property, problems on the line that
causes them, a components tree, previews with a flow diagram of every puller and pusher, and one-click
navigation between references.
- In your AI agent: the HexaSync knowledge base and project validation through an MCP server and agent
skills, so Claude Code, Codex, Cursor, Antigravity, pi, OpenClaw and GitHub Copilot answer from the official
reference instead of guessing from YAML already in the workspace.
Prerequisites
|
Needed for |
| VS Code 1.74 or newer (desktop, Remote-SSH, dev containers, code-server or the browser) |
the extension |
| The YAML extension by Red Hat (installed automatically) |
IntelliSense and hover |
| Node.js 22.13 or newer |
the MCP server and the AI toolkit for agents outside VS Code |
Works on Linux, macOS and Windows (x64 and arm64).
Get started in VS Code
- Install HexaSync Template IDE from the Extensions view, or from a
.vsix with
Extensions: Install from VSIX….
- Open the folder that holds your templates. A project is a folder whose
partials/ contains a main.yaml.
- Run HexaSync IDE: Install IntelliSense once per workspace. Run HexaSync IDE: Update IntelliSense
after updating the extension.
- Open any template
*.yaml: completion, hover and problems start working. Use HexaSync IDE: Select
Template Project when the workspace holds more than one project.
GitHub Copilot Chat in VS Code gets the HexaSync MCP server automatically. Check it with
HexaSync IDE: Check Template MCP Health.
Set up your AI agent
One command installs the MCP server and the HexaSync agent skills into every supported agent on this machine:
npx -y @beehexa/hexasync-ai-toolkit install --client all
- Pick agents with
--client claude,codex,cursor,antigravity,pi,openclaw,vscode.
- Use
--scope project to install into the current project instead of your user profile.
- Add
--dry-run to see every change first. Existing configuration is kept, and a backup is written before a
file is changed.
- Later:
npx -y @beehexa/hexasync-ai-toolkit update, or uninstall.
Restart the agent afterwards so it loads the server and the skills.
Add only the MCP server
| Agent |
How |
| Claude Code |
claude mcp add --transport stdio --scope user hexasync-template-ide -- npx -y @beehexa/hexasync-template-ide-mcp@latest |
| Codex |
codex mcp add hexasync-template-ide -- npx -y @beehexa/hexasync-template-ide-mcp@latest |
| Cursor |
add the JSON below to ~/.cursor/mcp.json |
| Antigravity |
add the JSON below to ~/.gemini/config/mcp_config.json |
| pi |
pi mcp add hexasync-template-ide -- npx -y @beehexa/hexasync-template-ide-mcp@latest |
| OpenClaw |
openclaw mcp add hexasync-template-ide --command npx --arg -y --arg @beehexa/hexasync-template-ide-mcp@latest |
| VS Code without this extension |
code --add-mcp '{"name":"hexasync-template-ide","command":"npx","args":["-y","@beehexa/hexasync-template-ide-mcp@latest"]}' |
{
"mcpServers": {
"hexasync-template-ide": {
"command": "npx",
"args": ["-y", "@beehexa/hexasync-template-ide-mcp@latest"]
}
}
}
Codex, if you prefer editing ~/.codex/config.toml:
[mcp_servers.hexasync-template-ide]
command = "npx"
args = ["-y", "@beehexa/hexasync-template-ide-mcp@latest"]
startup_timeout_sec = 30
On Windows, if your agent cannot start npx directly, use "command": "cmd" with
"args": ["/c", "npx", "-y", "@beehexa/hexasync-template-ide-mcp@latest"].
The server validates the project in the folder your agent has open. To point it elsewhere, add
--root <absolute path> to the arguments.
Add only the skills
npx -y @beehexa/hexasync-ai-toolkit install --client all --skills-only
The skills cover templates in general, pullers, pushers, webhooks, API steps, control and data steps, the
Query DSL, expressions, transformations, validations, connections, tables and tasks, startup tasks and
scheduling, metrics and reports, error handling and field mapping.
Try these prompts
After setup, ask your agent things like:
- "How do I configure
where in a Query DSL step? Show a full example."
- "Write a puller that pulls a paged REST endpoint incrementally and saves each field to a snake_case column."
- "Handle HTTP and response errors in this puller with one classification step and an Error step."
- "What does
logOutput do on a step, and what is its default?"
- "Which roots can I use in an expression inside a pusher step?"
- "Validate this project and explain each problem."
- "Schedule this task to pull every 15 minutes and enqueue every hour."
The agent looks the answer up in the HexaSync knowledge base and validates the project before saying it is done.
What you get in the editor
|
|
| IntelliSense |
completion and hover for every component and property, with syntax, meaning and defaults |
| Problems |
unresolved references, dangling ids and legacy configuration, on the line that causes them |
| Components tree |
every collection in the project and what each component uses, including what is inherited |
| Navigation |
Find Project, Find Component, Open Referenced…, Find References |
| Preview |
a component's overview, relations, data in and out, and a flow diagram whose nodes jump to their step |
| Dependency graph |
a component and what connects to it |
| Explain This Value |
where an inherited value came from |
| Compose Current Project |
composes your unsaved files and explains the result, writing nothing |
| Rename |
F2 renames a component or reference across the project |
| Authoring |
create connections and variables, generate UUIDs, quick fixes for reference problems |
All commands start with HexaSync IDE: in the Command Palette. Logs go to the HexaSync Templates output
channel.
Troubleshooting
- The agent does not use HexaSync: restart it, then ask for HexaSync explicitly, e.g. "use
hexasync-template-ide to explain…". In Claude Code,
claude mcp list should show hexasync-template-ide as
connected.
- Two
hexasync-template-ide servers in VS Code: remove the manual entry; the extension already provides one.
- The server does not start: check
node --version is 22.13 or newer.
- "No project" when validating: open the template folder in the agent, or add
--root <absolute path>.
- No IntelliSense: run HexaSync IDE: Install IntelliSense, and make sure the YAML extension is enabled.