MCP Tools & Endpoints.
Complete reference for every Model Context Protocol tool available in Synapse. Use these tools from any MCP-compatible IDE.
sync_workspace
Sync local files to a Synapse project. Uploads modified files, resolves conflicts, and ensures your remote workspace matches your local state.
Parameters
| Name | Type | Description |
|---|---|---|
project_id | string | The Synapse project identifier |
direction | "push" | "pull" | Sync direction — push local changes or pull remote changes |
paths | string[] | Optional list of file paths to sync (defaults to all changed files) |
force | boolean | Skip conflict detection and overwrite (default: false) |
execute_agent
Run an AI agent on specified files in your project. The PM agent breaks down your prompt into tasks and delegates to specialist agents.
Parameters
| Name | Type | Description |
|---|---|---|
project_id | string | The Synapse project identifier |
agent_type | "pm" | "liquid" | "css" | "js" | "review" | Which agent to invoke |
prompt | string | Natural language description of the desired change |
files | string[] | Optional file paths to scope the agent to |
apply_changes
Apply a set of suggested file changes to the project. Typically called after reviewing agent output to commit the modifications.
Parameters
| Name | Type | Description |
|---|---|---|
project_id | string | The Synapse project identifier |
changeset_id | string | ID of the changeset to apply (from agent output) |
files | string[] | Optional subset of files to apply (defaults to all) |
preview | boolean | Apply to preview theme instead of main (default: true) |
read_file
Read the contents of a file from a Synapse project. Returns the raw file content as a string along with metadata.
Parameters
| Name | Type | Description |
|---|---|---|
project_id | string | The Synapse project identifier |
path | string | Relative file path within the project (e.g. "sections/header.liquid") |
version | string | Optional version ID to read a historical snapshot |
write_file
Write content to a file in a Synapse project. Creates the file if it doesn't exist, or replaces the existing content.
Parameters
| Name | Type | Description |
|---|---|---|
project_id | string | The Synapse project identifier |
path | string | Relative file path within the project |
content | string | The full file content to write |
message | string | Optional commit message describing the change |
list_projects
List all Synapse projects belonging to the authenticated user. Returns project metadata including name, store, and sync status.
Parameters
| Name | Type | Description |
|---|---|---|
limit | number | Max number of projects to return (default: 20) |
offset | number | Pagination offset (default: 0) |
status | "active" | "archived" | Filter by project status (default: "active") |