SynchronexBack to synchronex.ai
Docs
Synchronex

Getting Started

OverviewQuickstartAuthentication

Core Concepts

Identity KernelMemoryDecisions FeedAI WorkersWorkspaces / Teams

Integration

REST APIMCP ServerMCP ToolsCloud Developer ModeOAuthSendinelBYOK

Reference

API ReferenceChangelog

Integration

MCP Tools

Full Synchronex MCP tool reference generated from the tool registry.

8 min read

Tool Table

ToolDescriptionInputsScope
register_sessionRegister this AI session with Synchronex so it appears in the pane picker. Call this at the very start of every session. If you have a remote share URL (Claude Code: /share), pass it as session_url — Synchronex will offer it as a live pane in the terminal grid. Returns a session_id to use in subsequent calls.product_name, session_url, agent_name, label, metadatawrite
end_sessionSignal that this IDE session has ended. Synchronex will summarize decisions made during the session, update the Product State Document, and write a handoff note for the next session. Call this in your IDE teardown hook or at the end of each session. Returns decisions_captured and handoff_note for confirmation.session_id, summary, ended_bywrite
get_identity_kernelReturns the user's Identity Kernel — identity, product portfolio, standing constraints, and model preferences. Inject the returned injection_block at the start of every session to restore persistent identity context.session_id, client_typeread
get_product_stateReturns the current Product State Document for a specific product, including last session summary, handoff note, what works, blockers, and open questions.product_nameread
search_decisionsSemantic search over the cross-product decision history. Returns ranked, relevant decisions trimmed to a token budget. Falls back to keyword search if embeddings are unavailable.query, product_name, limit, token_budgetread
get_session_handoffReturns the handoff note (next_session_starts_here) for a product. Use this at the very start of a session to orient before loading full state. The lightest memory call available.product_nameread
check_memory_confidenceAudits a session context block for stale data, constraint violations, and overall confidence score. Paste your CLAUDE.md or any injected memory block to validate it before relying on it.contextread
log_decisionWrites a new architectural or product decision to the cross-product decision index. Auto-tags, generates an embedding, and calculates temporal weight. Use this when a significant decision is made during a session.decision, reasoning, product_name, affects_productswrite
log_project_eventRecord a project signal or event into the Synchronex command center. Use for deployments, errors, decisions, and any notable state change.project_id, event_type, title, severity, body, occurred_atwrite
export_kernelExports the authenticated user's active kernel into client-specific formats or a registered scaffold template.format, template_id, product_name, budget, session_id, client_typeread
memory_kernel_readConfirms that the AI agent loaded the Synchronex Identity Kernel for this session. Call once after reading the exported kernel or receiving kernel context.session_id, sentinel_token, kernel_fingerprintread
update_product_stateUpdates the Product State Document for a specific product. Accepts partial updates — only provided fields are changed. Creates the state document if it doesn't exist yet.product_name, last_session_summary, next_session_starts_here, status, what_works, what_is_blocked, open_questionswrite
studio_generateQueue brand-aware content generation. Video requests use the async studio job pattern; poll with studio_get_job.content_type, brief, format, workspace_id, brand_id, provider, metadatawrite
studio_planQueue a brand-aware content lane plan from a brief.brief, duration_weeks, workspace_id, brand_idwrite
studio_proposeQueue content variants for approval from an existing generation request.generation_request_id, variant_countwrite
studio_get_jobPoll a studio generation job or async media job.job_idread
worker_listList active Synchronex workers and recent run state.status, workspace_idread
worker_runTrigger an active worker run. Returns immediately with a run id; poll with worker_get_run.worker_type, task, workspace_id, brand_id, inputwrite
worker_get_runRead the status and output of a worker run.run_idread
worker_approveApprove an escalated worker run and resume execution. Requires full-scope MCP credentials.run_id, decision_reason, edited_actionfull
kernel_getRead the authenticated user Identity Kernel.noneread
kernel_update_sliceMerge a validated partial update into one Identity Kernel slice.slice_name, updateswrite
kernel_list_productsList products managed by the authenticated user.noneread
ceo_briefList pending CEO proposals and escalated worker runs awaiting review.limitread
ceo_approveApprove a CEO proposal or escalated worker run. Requires full-scope MCP credentials.proposal_id, run_id, notesfull
ceo_rejectReject a CEO proposal or escalated worker run with feedback. Requires full-scope MCP credentials.proposal_id, run_id, feedbackfull
memory_kernel_readReturns the authenticated user Identity Kernel as structured JSON.noneread
memory_kernel_updateMerges a partial update into the authenticated user Identity Kernel.updateswrite
memory_searchSearches memory layers (kernel, product state, decisions); decisions use semantic pgvector search.query, limit, layerread
memory_product_state_readReturns the current state document for a product by name.productread
memory_product_state_writeApplies partial updates to a product state document.product, updateswrite
memory_decision_logAppends a cross-product decision to the decision index.decision, context, products_affectedwrite
memory_session_summaryStores a cross-AI session summary with attribution.summary, topics, ai_toolwrite
list_registered_workspacesLists registered Synchronex workspace sync targets for the authenticated user.noneread
get_drift_eventsLists workspace drift events for the authenticated user.statusread
approve_inbound_changeAccepts or rejects a pending workspace drift event.action, note, resolved_by, drift_event_idwrite
sync_workspace_stateRenders the current kernel export for a registered workspace. The MCP client writes the returned file content locally.workspace_registration_idwrite

register_session

Register this AI session with Synchronex so it appears in the pane picker. Call this at the very start of every session. If you have a remote share URL (Claude Code: /share), pass it as session_url — Synchronex will offer it as a live pane in the terminal grid. Returns a session_id to use in subsequent calls.

Scope: write. Inputs: product_namesession_urlagent_namelabelmetadata.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "register_session",
    "arguments": {
      "product_name": "example"
    }
  }
}

end_session

Signal that this IDE session has ended. Synchronex will summarize decisions made during the session, update the Product State Document, and write a handoff note for the next session. Call this in your IDE teardown hook or at the end of each session. Returns decisions_captured and handoff_note for confirmation.

Scope: write. Inputs: session_idsummaryended_by.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "end_session",
    "arguments": {
      "session_id": "example"
    }
  }
}

get_identity_kernel

Returns the user's Identity Kernel — identity, product portfolio, standing constraints, and model preferences. Inject the returned injection_block at the start of every session to restore persistent identity context.

Scope: read. Inputs: session_idclient_type.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "get_identity_kernel",
    "arguments": {
      "session_id": "example"
    }
  }
}

get_product_state

Returns the current Product State Document for a specific product, including last session summary, handoff note, what works, blockers, and open questions.

Scope: read. Inputs: product_name.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "get_product_state",
    "arguments": {
      "product_name": "example"
    }
  }
}

search_decisions

Semantic search over the cross-product decision history. Returns ranked, relevant decisions trimmed to a token budget. Falls back to keyword search if embeddings are unavailable.

Scope: read. Inputs: queryproduct_namelimittoken_budget.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "search_decisions",
    "arguments": {
      "query": "example"
    }
  }
}

get_session_handoff

Returns the handoff note (next_session_starts_here) for a product. Use this at the very start of a session to orient before loading full state. The lightest memory call available.

Scope: read. Inputs: product_name.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "get_session_handoff",
    "arguments": {
      "product_name": "example"
    }
  }
}

check_memory_confidence

Audits a session context block for stale data, constraint violations, and overall confidence score. Paste your CLAUDE.md or any injected memory block to validate it before relying on it.

Scope: read. Inputs: context.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "check_memory_confidence",
    "arguments": {
      "context": "example"
    }
  }
}

log_decision

Writes a new architectural or product decision to the cross-product decision index. Auto-tags, generates an embedding, and calculates temporal weight. Use this when a significant decision is made during a session.

Scope: write. Inputs: decisionreasoningproduct_nameaffects_products.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "log_decision",
    "arguments": {
      "decision": "example"
    }
  }
}

log_project_event

Record a project signal or event into the Synchronex command center. Use for deployments, errors, decisions, and any notable state change.

Scope: write. Inputs: project_idevent_typetitleseveritybodyoccurred_at.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "log_project_event",
    "arguments": {
      "project_id": "example"
    }
  }
}

export_kernel

Exports the authenticated user's active kernel into client-specific formats or a registered scaffold template.

Scope: read. Inputs: formattemplate_idproduct_namebudgetsession_idclient_type.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "export_kernel",
    "arguments": {
      "format": "example"
    }
  }
}

memory_kernel_read

Confirms that the AI agent loaded the Synchronex Identity Kernel for this session. Call once after reading the exported kernel or receiving kernel context.

Scope: read. Inputs: session_idsentinel_tokenkernel_fingerprint.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_kernel_read",
    "arguments": {
      "session_id": "example"
    }
  }
}

update_product_state

Updates the Product State Document for a specific product. Accepts partial updates — only provided fields are changed. Creates the state document if it doesn't exist yet.

Scope: write. Inputs: product_namelast_session_summarynext_session_starts_herestatuswhat_workswhat_is_blockedopen_questions.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "update_product_state",
    "arguments": {
      "product_name": "example"
    }
  }
}

studio_generate

Queue brand-aware content generation. Video requests use the async studio job pattern; poll with studio_get_job.

Scope: write. Inputs: content_typebriefformatworkspace_idbrand_idprovidermetadata.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "studio_generate",
    "arguments": {
      "content_type": "example"
    }
  }
}

studio_plan

Queue a brand-aware content lane plan from a brief.

Scope: write. Inputs: briefduration_weeksworkspace_idbrand_id.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "studio_plan",
    "arguments": {
      "brief": "example"
    }
  }
}

studio_propose

Queue content variants for approval from an existing generation request.

Scope: write. Inputs: generation_request_idvariant_count.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "studio_propose",
    "arguments": {
      "generation_request_id": "example"
    }
  }
}

studio_get_job

Poll a studio generation job or async media job.

Scope: read. Inputs: job_id.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "studio_get_job",
    "arguments": {
      "job_id": "example"
    }
  }
}

worker_list

List active Synchronex workers and recent run state.

Scope: read. Inputs: statusworkspace_id.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "worker_list",
    "arguments": {
      "status": "example"
    }
  }
}

worker_run

Trigger an active worker run. Returns immediately with a run id; poll with worker_get_run.

Scope: write. Inputs: worker_typetaskworkspace_idbrand_idinput.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "worker_run",
    "arguments": {
      "worker_type": "example"
    }
  }
}

worker_get_run

Read the status and output of a worker run.

Scope: read. Inputs: run_id.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "worker_get_run",
    "arguments": {
      "run_id": "example"
    }
  }
}

worker_approve

Approve an escalated worker run and resume execution. Requires full-scope MCP credentials.

Scope: full. Inputs: run_iddecision_reasonedited_action.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "worker_approve",
    "arguments": {
      "run_id": "example"
    }
  }
}

kernel_get

Read the authenticated user Identity Kernel.

Scope: read. Inputs: none.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "kernel_get",
    "arguments": {}
  }
}

kernel_update_slice

Merge a validated partial update into one Identity Kernel slice.

Scope: write. Inputs: slice_nameupdates.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "kernel_update_slice",
    "arguments": {
      "slice_name": "example"
    }
  }
}

kernel_list_products

List products managed by the authenticated user.

Scope: read. Inputs: none.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "kernel_list_products",
    "arguments": {}
  }
}

ceo_brief

List pending CEO proposals and escalated worker runs awaiting review.

Scope: read. Inputs: limit.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "ceo_brief",
    "arguments": {
      "limit": "example"
    }
  }
}

ceo_approve

Approve a CEO proposal or escalated worker run. Requires full-scope MCP credentials.

Scope: full. Inputs: proposal_idrun_idnotes.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "ceo_approve",
    "arguments": {
      "proposal_id": "example"
    }
  }
}

ceo_reject

Reject a CEO proposal or escalated worker run with feedback. Requires full-scope MCP credentials.

Scope: full. Inputs: proposal_idrun_idfeedback.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "ceo_reject",
    "arguments": {
      "proposal_id": "example"
    }
  }
}

memory_kernel_read

Returns the authenticated user Identity Kernel as structured JSON.

Scope: read. Inputs: none.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_kernel_read",
    "arguments": {}
  }
}

memory_kernel_update

Merges a partial update into the authenticated user Identity Kernel.

Scope: write. Inputs: updates.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_kernel_update",
    "arguments": {
      "updates": "example"
    }
  }
}

memory_search

Searches memory layers (kernel, product state, decisions); decisions use semantic pgvector search.

Scope: read. Inputs: querylimitlayer.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_search",
    "arguments": {
      "query": "example"
    }
  }
}

memory_product_state_read

Returns the current state document for a product by name.

Scope: read. Inputs: product.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_product_state_read",
    "arguments": {
      "product": "example"
    }
  }
}

memory_product_state_write

Applies partial updates to a product state document.

Scope: write. Inputs: productupdates.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_product_state_write",
    "arguments": {
      "product": "example"
    }
  }
}

memory_decision_log

Appends a cross-product decision to the decision index.

Scope: write. Inputs: decisioncontextproducts_affected.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_decision_log",
    "arguments": {
      "decision": "example"
    }
  }
}

memory_session_summary

Stores a cross-AI session summary with attribution.

Scope: write. Inputs: summarytopicsai_tool.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "memory_session_summary",
    "arguments": {
      "summary": "example"
    }
  }
}

list_registered_workspaces

Lists registered Synchronex workspace sync targets for the authenticated user.

Scope: read. Inputs: none.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "list_registered_workspaces",
    "arguments": {}
  }
}

get_drift_events

Lists workspace drift events for the authenticated user.

Scope: read. Inputs: status.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "get_drift_events",
    "arguments": {
      "status": "example"
    }
  }
}

approve_inbound_change

Accepts or rejects a pending workspace drift event.

Scope: write. Inputs: actionnoteresolved_bydrift_event_id.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "approve_inbound_change",
    "arguments": {
      "action": "example"
    }
  }
}

sync_workspace_state

Renders the current kernel export for a registered workspace. The MCP client writes the returned file content locally.

Scope: write. Inputs: workspace_registration_id.

json
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "name": "sync_workspace_state",
    "arguments": {
      "workspace_registration_id": "example"
    }
  }
}