Skip to main content

Import & Export

Synapse supports portable bundle files that contain agents, orchestrations, and MCP server configurations. Use them to share your work, back up configurations, or deploy across environments.

What's in a bundle

A bundle is a single JSON file containing:

  • Agent definitions (system prompts, tool lists, model overrides)
  • Orchestration DAGs (steps, edges, guardrails)
  • MCP server configurations
  • Custom tool definitions

Vault files and conversation history are not included — bundles are configuration-only.

Exporting

Via the UI

  1. Go to the canvas or settings page
  2. Click Export on any agent, orchestration, or use Export All to bundle everything
  3. A .bundle.json file is downloaded

Importing

Via the UI

  1. Go to Settings → Import
  2. Drag and drop your .bundle.json file (or click to select)
  3. Review the contents — agents, orchestrations, and MCP configs
  4. Click Import

Existing items with the same ID are updated. New items are created.

Example bundles

Synapse ships with example bundles for common use cases. Find them in Settings → Examples or in backend/examples/:

BundleDescription
research_reporterResearch agent + report writer + human review orchestration
data_analystSQL agent + chart generator + scheduled daily reports
code_reviewerCode search + review agent + GitHub MCP integration
customer_supportTriage orchestration + Slack messaging + escalation flow

Click Import on any example to add it to your Synapse instance instantly.

Bundle format

{
"version": "1.0",
"exported_at": "2024-11-15T14:30:00Z",
"agents": [
{
"id": "agent-abc123",
"name": "Research Agent",
"type": "conversational",
"tools": ["all"],
"system_prompt": "...",
"model": null
}
],
"orchestrations": [
{
"id": "orch-research-report",
"name": "Research → Report",
"steps": [ ... ]
}
],
"mcp_servers": [
{
"name": "github",
"server_type": "remote",
"url": "https://api.githubcopilot.com/mcp/"
}
],
"custom_tools": [
{
"name": "get_weather",
"tool_type": "http",
"method": "GET",
"url": "https://api.weather.com/..."
}
]
}

Version control

Commit your bundle files to git to version-control your agent configurations:

# Export current state
synapse export > bundles/production-v1.4.bundle.json
git add bundles/
git commit -m "chore: export agent configs v1.4"

# Restore on a new machine
synapse import bundles/production-v1.4.bundle.json

Sharing with the community

Share your bundles on GitHub or Discord to help others build similar workflows. The Synapse community maintains a growing library of example bundles at github.com/naveenraj-17/synapse-ai/examples.