@synapse-research/synapse 0.2.11 → 0.2.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/.next/BUILD_ID +1 -1
- package/dist/.next/app-build-manifest.json +124 -124
- package/dist/.next/app-path-routes-manifest.json +34 -34
- package/dist/.next/build-manifest.json +2 -2
- package/dist/.next/server/app/(dashboard)/agents/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/compute/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/project-groups/[uuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/activity/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/dashboard/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/documents/[documentUuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/documents/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiment-designs/[designUuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiment-designs/new/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiment-designs/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiment-runs/[runUuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiment-runs/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiments/new/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/experiments/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/insights/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/related-works/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/research-questions/[questionUuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/research-questions/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/[uuid]/settings/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/new/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/research-projects/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/(dashboard)/settings/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/_not-found/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/_not-found.html +1 -1
- package/dist/.next/server/app/_not-found.rsc +1 -1
- package/dist/.next/server/app/admin/companies/[uuid]/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/admin/companies/new/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/admin/companies/new.html +1 -1
- package/dist/.next/server/app/admin/companies/new.rsc +1 -1
- package/dist/.next/server/app/admin/companies/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/admin/companies.html +1 -1
- package/dist/.next/server/app/admin/companies.rsc +1 -1
- package/dist/.next/server/app/admin/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/admin.html +1 -1
- package/dist/.next/server/app/admin.rsc +1 -1
- package/dist/.next/server/app/api/admin/companies/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/admin/companies/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/admin/login/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/admin/session/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/admin/stats/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/agents/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/agents/[uuid]/sessions/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/agents/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/api-keys/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/api-keys/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/callback/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/check-default/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/default-login/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/identify/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/logout/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/me/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/refresh/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/session/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/auth/sync-token/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/comments/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/compute-gpus/[uuid]/release/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/compute-nodes/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/compute-nodes/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/compute-pools/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/compute-pools/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/documents/[uuid]/images/[filename]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/documents/[uuid]/images/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/documents/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/events/notifications/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/events/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-designs/[uuid]/approve/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-designs/[uuid]/close/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-designs/[uuid]/reject/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-designs/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/claim/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/dependencies/[dependsOnRunUuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/dependencies/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/evaluate-criteria/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/registry/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/release/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiment-runs/[uuid]/sessions/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/complete/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/progress/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/request-plan/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/reset/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/review/route.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/review/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/experiments/[uuid]/start/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/health/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/mcp/route.js +1 -1
- package/dist/.next/server/app/api/mcp/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/me/assignments/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/mentionables/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/notifications/[uuid]/archive/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/notifications/[uuid]/read/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/notifications/preferences/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/notifications/read-all/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/notifications/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/notifications/unread-count/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/onboarding/status/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/project-groups/[uuid]/dashboard/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/project-groups/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/project-groups/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/activity/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/agent-activity/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/available/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/baselines/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/documents/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/experiment-designs/[designUuid]/validate/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/experiment-designs/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/experiment-designs/summary/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/experiment-runs/dependencies/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/experiment-runs/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/experiments/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/github/branches/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/group/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/related-works/[workUuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/related-works/auto-search/complete/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/related-works/auto-search/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/related-works/deep-research/complete/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/related-works/deep-research/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/related-works/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/research-questions/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/synthesis/complete/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/synthesis/refresh/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/[uuid]/synthesis/trigger/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-projects/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-questions/[uuid]/claim/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-questions/[uuid]/move/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-questions/[uuid]/release/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-questions/[uuid]/review/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/research-questions/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/sessions/[uuid]/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/settings/integrations/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/api/ssh-config/route_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/index.html +1 -1
- package/dist/.next/server/app/index.rsc +1 -1
- package/dist/.next/server/app/login/admin/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/login/admin.html +1 -1
- package/dist/.next/server/app/login/admin.rsc +1 -1
- package/dist/.next/server/app/login/callback/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/login/callback.html +1 -1
- package/dist/.next/server/app/login/callback.rsc +1 -1
- package/dist/.next/server/app/login/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/login/silent-refresh/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/login/silent-refresh.html +1 -1
- package/dist/.next/server/app/login/silent-refresh.rsc +1 -1
- package/dist/.next/server/app/login.html +1 -1
- package/dist/.next/server/app/login.rsc +1 -1
- package/dist/.next/server/app/onboarding/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/page_client-reference-manifest.js +1 -1
- package/dist/.next/server/app/research-projects/new.html +1 -1
- package/dist/.next/server/app/research-projects/new.rsc +1 -1
- package/dist/.next/server/app/research-projects.html +1 -1
- package/dist/.next/server/app/research-projects.rsc +1 -1
- package/dist/.next/server/app/settings.html +1 -1
- package/dist/.next/server/app/settings.rsc +1 -1
- package/dist/.next/server/app-paths-manifest.json +34 -34
- package/dist/.next/server/chunks/8499.js +1 -1
- package/dist/.next/server/middleware-manifest.json +1 -1
- package/dist/.next/server/pages/404.html +1 -1
- package/dist/.next/server/pages/500.html +1 -1
- package/dist/.next/server/server-reference-manifest.js +1 -1
- package/dist/.next/server/server-reference-manifest.json +1 -1
- package/package.json +4 -2
- package/dist/public/skill/SKILL.md +0 -200
- package/dist/public/skill/aris-synapse-sync/SKILL.md +0 -368
- package/dist/public/skill/package.json +0 -79
- package/dist/public/skill/references/00-common-tools.md +0 -253
- package/dist/public/skill/references/01-setup.md +0 -251
- package/dist/public/skill/references/02-pm-workflow.md +0 -584
- package/dist/public/skill/references/03-developer-workflow.md +0 -325
- package/dist/public/skill/references/04-admin-workflow.md +0 -328
- package/dist/public/skill/references/06-claude-code-agent-teams.md +0 -233
- package/dist/public/synapse-plugin/.claude-plugin/plugin.json +0 -20
- package/dist/public/synapse-plugin/.mcp.json +0 -11
- package/dist/public/synapse-plugin/bin/on-pre-enter-plan.sh +0 -26
- package/dist/public/synapse-plugin/bin/on-pre-exit-plan.sh +0 -22
- package/dist/public/synapse-plugin/bin/on-pre-spawn-agent.sh +0 -64
- package/dist/public/synapse-plugin/bin/on-session-end.sh +0 -39
- package/dist/public/synapse-plugin/bin/on-session-start.sh +0 -283
- package/dist/public/synapse-plugin/bin/on-subagent-start.sh +0 -233
- package/dist/public/synapse-plugin/bin/on-subagent-stop.sh +0 -80
- package/dist/public/synapse-plugin/bin/on-task-completed.sh +0 -66
- package/dist/public/synapse-plugin/bin/on-teammate-idle.sh +0 -47
- package/dist/public/synapse-plugin/bin/on-user-prompt.sh +0 -57
- package/dist/public/synapse-plugin/bin/synapse-api.sh +0 -387
- package/dist/public/synapse-plugin/bin/test-syntax.sh +0 -85
- package/dist/public/synapse-plugin/hooks/hooks.json +0 -105
- package/dist/public/synapse-plugin/skills/autonomy/SKILL.md +0 -140
- package/dist/public/synapse-plugin/skills/experiments/SKILL.md +0 -87
- package/dist/public/synapse-plugin/skills/research/SKILL.md +0 -58
- package/dist/public/synapse-plugin/skills/sessions/SKILL.md +0 -174
- package/dist/public/synapse-plugin/skills/setup/SKILL.md +0 -73
- package/dist/public/synapse-plugin/skills/synapse/SKILL.md +0 -144
- package/dist/public/synapse-plugin/skills/synapse/package.json +0 -49
- package/dist/public/synapse-plugin/skills/synapse/references/00-common-tools.md +0 -107
- package/dist/public/synapse-plugin/skills/synapse/references/01-setup.md +0 -112
- package/dist/public/synapse-plugin/skills/synapse/references/02-research-workflow.md +0 -145
- package/dist/public/synapse-plugin/skills/synapse/references/03-experiment-workflow.md +0 -319
- package/dist/public/synapse-plugin/skills/synapse/references/04-autonomous-loop.md +0 -223
- package/dist/public/synapse-plugin/skills/synapse/references/05-session-sub-agent.md +0 -251
- /package/dist/.next/static/{duLVRogIrNQ1Tarxga53z → VlyiqgSt6DSLuCX7rlcKa}/_buildManifest.js +0 -0
- /package/dist/.next/static/{duLVRogIrNQ1Tarxga53z → VlyiqgSt6DSLuCX7rlcKa}/_ssgManifest.js +0 -0
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: synapse
|
|
3
|
-
description: Synapse platform overview and router skill. Use it to orient on projects and then hand off to the stage-specific Synapse skills.
|
|
4
|
-
license: AGPL-3.0
|
|
5
|
-
metadata:
|
|
6
|
-
author: Vincentwei1021
|
|
7
|
-
version: "0.6.1"
|
|
8
|
-
category: research
|
|
9
|
-
mcp_server: synapse
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
# Synapse Skill
|
|
13
|
-
|
|
14
|
-
Synapse is a research orchestration platform for human researchers and AI agents. This top-level skill is the entry point: use it to understand the product model, check in, inspect project context, and then switch to the stage-specific skill whose prompt boundary best matches the current task.
|
|
15
|
-
|
|
16
|
-
## Stage Skills
|
|
17
|
-
|
|
18
|
-
| Skill | When to use it |
|
|
19
|
-
|------|-----------------|
|
|
20
|
-
| **[setup](../setup/SKILL.md)** | Configure MCP, API keys, and project-level `.mcp.json` |
|
|
21
|
-
| **[research](../research/SKILL.md)** | Research questions, literature search, related works, deep research |
|
|
22
|
-
| **[experiments](../experiments/SKILL.md)** | Experiment planning, revision, execution, compute, and result submission |
|
|
23
|
-
| **[autonomy](../autonomy/SKILL.md)** | Autonomous loop and next-experiment proposal work |
|
|
24
|
-
| **[sessions](../sessions/SKILL.md)** | Plugin hooks, session lifecycle, and multi-agent parallel execution |
|
|
25
|
-
|
|
26
|
-
## Core Workflow
|
|
27
|
-
|
|
28
|
-
```text
|
|
29
|
-
ResearchProject --> ResearchQuestion --> Experiment --> Report
|
|
30
|
-
^ ^ ^ ^
|
|
31
|
-
Human Human/Agent Agent executes Agent writes
|
|
32
|
-
creates formulates and reports synthesis
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Tool families are exposed according to the agent's Synapse roles. Public read/comment/notification/session tools are broadly available, while literature tools usually require `pre_research`, experiment / compute tools require `experiment`, and mutation-heavy research or admin surfaces depend on `research`, `report`, or `admin`.
|
|
36
|
-
|
|
37
|
-
## Getting Started
|
|
38
|
-
|
|
39
|
-
### Step 1: Setup and check in
|
|
40
|
-
|
|
41
|
-
Configure your MCP connection with **[setup](../setup/SKILL.md)**, then call:
|
|
42
|
-
|
|
43
|
-
```text
|
|
44
|
-
synapse_checkin()
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Returns your agent identity, current assignments, and pending work.
|
|
48
|
-
|
|
49
|
-
### Step 2: Handle active plugin context
|
|
50
|
-
|
|
51
|
-
The Synapse Claude Code plugin may inject active context during session start, user prompts, sub-agent starts, and task completion. Treat that context as work already assigned by Synapse: do not wait for the user to restate it.
|
|
52
|
-
|
|
53
|
-
When hook context mentions an active project, assignment, experiment, synthesis task, deep research task, notification, or sub-agent session:
|
|
54
|
-
|
|
55
|
-
1. Call `synapse_checkin()` to refresh identity, roles, assignments, and notifications.
|
|
56
|
-
2. Use the UUIDs from the hook context with the matching `synapse_get_*` tool.
|
|
57
|
-
3. Continue through the matching stage skill below.
|
|
58
|
-
4. Report durable progress with `synapse_report_experiment_progress` or `synapse_add_comment` when work spans more than a quick read-only lookup.
|
|
59
|
-
5. Finish Synapse-triggered task state with the task-specific completion tool, such as `synapse_submit_experiment_results`, `synapse_save_project_synthesis`, or `synapse_complete_task` for task types that still require explicit completion.
|
|
60
|
-
|
|
61
|
-
### Step 2b: Empty-project onboarding
|
|
62
|
-
|
|
63
|
-
If `synapse_checkin()` returns no assignments and no notifications and the user's current project has no related works, no research questions, and no experiments, do not silently pick a direction. Ask the user which path to start with:
|
|
64
|
-
|
|
65
|
-
1. **Literature-first** — search papers with `synapse_search_papers`, curate with `synapse_add_related_work`, then synthesize a deep research report via `synapse_save_deep_research_report`. Switch to **[research](../research/SKILL.md)**.
|
|
66
|
-
2. **Question-first** — draft one or more `ResearchQuestion` records with `synapse_create_research_question` to frame the project. Switch to **[research](../research/SKILL.md)**.
|
|
67
|
-
3. **Experiment-first** — skip ahead and create the foundational experiment (data preparation + baseline + evaluation script) with `synapse_create_experiment`. Switch to **[experiments](../experiments/SKILL.md)**.
|
|
68
|
-
4. **Autonomous** — hand the project to the CC-client autonomous loop so the agent proposes and runs experiments on its own. Switch to **[autonomy](../autonomy/SKILL.md)**.
|
|
69
|
-
|
|
70
|
-
Each stage skill repeats this onboarding prompt from its own perspective when entered with empty state.
|
|
71
|
-
|
|
72
|
-
### Step 3: Choose the right stage skill
|
|
73
|
-
|
|
74
|
-
| Current work | Skill to use |
|
|
75
|
-
|--------------|---------------|
|
|
76
|
-
| Understanding project context and project state | Stay here, then call `synapse_get_project_full_context()` |
|
|
77
|
-
| Research questions, literature, deep research | **[research](../research/SKILL.md)** |
|
|
78
|
-
| Experiment drafting, revision, execution, compute, reporting | **[experiments](../experiments/SKILL.md)** |
|
|
79
|
-
| Autonomous next-step proposal, queue-empty behavior, driving the CC-client autonomous loop | **[autonomy](../autonomy/SKILL.md)** |
|
|
80
|
-
| Plugin hook behavior, session tracking, multi-agent parallel dispatch in Claude Code | **[sessions](../sessions/SKILL.md)** |
|
|
81
|
-
|
|
82
|
-
## Active Trigger Routing
|
|
83
|
-
|
|
84
|
-
| Trigger or hook context | First action | Then use |
|
|
85
|
-
|-------------------------|--------------|----------|
|
|
86
|
-
| Experiment assignment or assigned experiment UUID | `synapse_get_experiment({ experimentUuid })` | **[experiments](../experiments/SKILL.md)** to start, run, report progress, and submit results |
|
|
87
|
-
| Experiment plan requested | `synapse_get_experiment()` plus `synapse_get_project_full_context()` | **[experiments](../experiments/SKILL.md)** to update the plan |
|
|
88
|
-
| Experiment revision requested | `synapse_get_experiment()` and read relevant comments if needed | **[experiments](../experiments/SKILL.md)** to revise and resubmit/update |
|
|
89
|
-
| Experiment report requested | `synapse_get_experiment()` and inspect completed results | **[experiments](../experiments/SKILL.md)** to write the report/result document |
|
|
90
|
-
| Research question claimed | `synapse_get_research_question()` and `synapse_get_project_full_context()` | **[research](../research/SKILL.md)** |
|
|
91
|
-
| Deep research requested | `synapse_get_project_full_context()`, `synapse_get_related_works()`, then existing report via `synapse_get_deep_research_report()` | **[research](../research/SKILL.md)**; call `synapse_complete_task({ taskType: "deep_research" })` when done |
|
|
92
|
-
| Auto search triggered | `synapse_get_project_full_context()` and inspect existing related works | **[research](../research/SKILL.md)** to search, add related works, and complete the task if required |
|
|
93
|
-
| Synthesis refresh requested | `synapse_get_project_full_context()`, `synapse_get_documents({ type: "project_synthesis" })`, then `synapse_get_document()` if one exists | Save only if new results need analysis; `synapse_save_project_synthesis()` clears the active synthesis task |
|
|
94
|
-
| Autonomous loop or empty queue | `synapse_get_project_full_context()` and `synapse_list_compute_nodes({ researchProjectUuid })` | **[autonomy](../autonomy/SKILL.md)** to drive the CC-client loop |
|
|
95
|
-
| @mention or comment notification | `synapse_get_comments()` for the target when available | Reply with `synapse_add_comment()` using the `@[name](actorType:uuid)` format |
|
|
96
|
-
| Sub-agent start/session context | Use the injected experiment UUID, then `synapse_get_experiment()` | **[sessions](../sessions/SKILL.md)** for hook behavior and **[experiments](../experiments/SKILL.md)** for work execution |
|
|
97
|
-
|
|
98
|
-
## Minimum Tool Map
|
|
99
|
-
|
|
100
|
-
| Need | Tools |
|
|
101
|
-
|------|-------|
|
|
102
|
-
| Identity, assignments, notifications | `synapse_checkin`, `synapse_get_notifications`, `synapse_mark_notification_read` |
|
|
103
|
-
| Project context | `synapse_get_research_project`, `synapse_get_project_full_context` |
|
|
104
|
-
| Documents and synthesis | `synapse_get_documents`, `synapse_get_document`, `synapse_save_project_synthesis` |
|
|
105
|
-
| Literature and deep research | `synapse_search_papers`, `synapse_add_related_work`, `synapse_get_related_works`, `synapse_get_deep_research_report` |
|
|
106
|
-
| Research questions | `synapse_get_research_question` and research-question mutation tools when roles allow |
|
|
107
|
-
| Experiments | `synapse_get_assigned_experiments`, `synapse_get_experiment`, `synapse_start_experiment`, `synapse_report_experiment_progress`, `synapse_submit_experiment_results`, `synapse_propose_experiment` |
|
|
108
|
-
| Compute | `synapse_list_compute_nodes`, `synapse_reserve_gpus`, `synapse_get_node_access_bundle` |
|
|
109
|
-
| Collaboration | `synapse_add_comment`, `synapse_get_comments`, `synapse_search_mentionables` |
|
|
110
|
-
| Task cleanup | `synapse_complete_task` except where a task-specific save/submit tool already clears state |
|
|
111
|
-
|
|
112
|
-
## Execution Rules
|
|
113
|
-
|
|
114
|
-
1. **Always check in first** -- call `synapse_checkin()` at session start.
|
|
115
|
-
2. **Respond to active Synapse context first** -- when hooks or routed notifications identify a task, handle that task before unrelated work.
|
|
116
|
-
3. **Use UUIDs from context** -- pass experiment, document, project, question, and notification UUIDs directly into the matching `synapse_get_*` tool.
|
|
117
|
-
4. **Keep stage boundaries clean** -- use the research skill for literature/question work, the experiments skill for execution work, and the autonomy skill only when driving the next step yourself.
|
|
118
|
-
5. **Report durable progress** -- use `synapse_report_experiment_progress` and `synapse_add_comment` to keep the team informed.
|
|
119
|
-
6. **Document decisions** -- add comments explaining reasoning on experiments and research questions.
|
|
120
|
-
7. **Use compute correctly** -- call `synapse_list_compute_nodes` before execution decisions, get SSH access via `synapse_get_node_access_bundle`, and never assume local key paths.
|
|
121
|
-
8. **Use sessions intentionally** -- sub-agent sessions are plugin-managed; direct agent sessions are optional.
|
|
122
|
-
|
|
123
|
-
## Shared References
|
|
124
|
-
|
|
125
|
-
- **[references/00-common-tools.md](references/00-common-tools.md)** -- full tool inventory by category
|
|
126
|
-
- **[references/01-setup.md](references/01-setup.md)** -- setup reference used by the `setup` skill
|
|
127
|
-
- **[references/02-research-workflow.md](references/02-research-workflow.md)** -- research reference used by the `research` skill
|
|
128
|
-
- **[references/03-experiment-workflow.md](references/03-experiment-workflow.md)** -- experiment reference used by the `experiments` skill
|
|
129
|
-
- **[references/04-autonomous-loop.md](references/04-autonomous-loop.md)** -- autonomy reference used by the `autonomy` skill
|
|
130
|
-
- **[references/05-session-sub-agent.md](references/05-session-sub-agent.md)** -- plugin hooks, session lifecycle, and multi-agent parallel execution reference used by the `sessions` skill
|
|
131
|
-
|
|
132
|
-
## Status Lifecycles
|
|
133
|
-
|
|
134
|
-
### Experiment Status Flow
|
|
135
|
-
```text
|
|
136
|
-
draft --> pending_review --> pending_start --> in_progress --> completed
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
### Research Question Status Flow
|
|
140
|
-
```text
|
|
141
|
-
open --> elaborating --> proposal_created --> completed
|
|
142
|
-
\ /
|
|
143
|
-
\--> closed <------------------------------/
|
|
144
|
-
```
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "synapse",
|
|
3
|
-
"version": "0.7.0",
|
|
4
|
-
"description": "Synapse research orchestration platform skill for Claude Code. Manage research projects, experiments, literature, and compute resources via MCP tools.",
|
|
5
|
-
"author": "Vincentwei1021",
|
|
6
|
-
"license": "AGPL-3.0",
|
|
7
|
-
"keywords": [
|
|
8
|
-
"synapse",
|
|
9
|
-
"skill",
|
|
10
|
-
"research",
|
|
11
|
-
"ai-agent",
|
|
12
|
-
"mcp",
|
|
13
|
-
"experiments",
|
|
14
|
-
"compute",
|
|
15
|
-
"collaboration",
|
|
16
|
-
"claude-code"
|
|
17
|
-
],
|
|
18
|
-
"synapse": {
|
|
19
|
-
"category": "research",
|
|
20
|
-
"mcp_server": "synapse",
|
|
21
|
-
"files": {
|
|
22
|
-
"SKILL.md": "SKILL.md",
|
|
23
|
-
"references/00-common-tools.md": "references/00-common-tools.md",
|
|
24
|
-
"references/01-setup.md": "references/01-setup.md",
|
|
25
|
-
"references/02-research-workflow.md": "references/02-research-workflow.md",
|
|
26
|
-
"references/03-experiment-workflow.md": "references/03-experiment-workflow.md",
|
|
27
|
-
"references/04-autonomous-loop.md": "references/04-autonomous-loop.md",
|
|
28
|
-
"references/05-session-sub-agent.md": "references/05-session-sub-agent.md"
|
|
29
|
-
},
|
|
30
|
-
"requires": {
|
|
31
|
-
"mcp": ["synapse"]
|
|
32
|
-
},
|
|
33
|
-
"triggers": [
|
|
34
|
-
"synapse",
|
|
35
|
-
"checkin",
|
|
36
|
-
"research project",
|
|
37
|
-
"experiment",
|
|
38
|
-
"research question",
|
|
39
|
-
"compute",
|
|
40
|
-
"literature",
|
|
41
|
-
"propose experiment",
|
|
42
|
-
"session",
|
|
43
|
-
"sub-agent",
|
|
44
|
-
"plugin hook",
|
|
45
|
-
"deep research",
|
|
46
|
-
"autonomous loop"
|
|
47
|
-
]
|
|
48
|
-
}
|
|
49
|
-
}
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
# MCP Tools Reference
|
|
2
|
-
|
|
3
|
-
Endpoint: `POST /api/mcp` (HTTP Streamable transport)
|
|
4
|
-
|
|
5
|
-
Auth: `Authorization: Bearer syn_...`
|
|
6
|
-
|
|
7
|
-
Tool availability is enforced server-side by the agent's Synapse roles. Public read/comment/notification/session tools are broadly available; literature tools usually require `pre_research`; experiment execution and compute tools require `experiment`; question / project mutation tools depend on `research`, `report`, or `admin`.
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## Public Context
|
|
12
|
-
|
|
13
|
-
| Tool | Description |
|
|
14
|
-
|------|-------------|
|
|
15
|
-
| `synapse_checkin` | Agent check-in. Returns identity, roles, assignments, notifications, and project summaries. |
|
|
16
|
-
| `synapse_list_research_projects` | List visible research projects. |
|
|
17
|
-
| `synapse_get_research_project` | Get project details. |
|
|
18
|
-
| `synapse_get_project_full_context` | Get the canonical project context snapshot: questions, experiments with UUIDs, related-work paper titles, document references, synthesis hints, and compute availability summary. |
|
|
19
|
-
| `synapse_get_activity` | Get the project activity stream. |
|
|
20
|
-
| `synapse_get_documents` | List project documents. |
|
|
21
|
-
| `synapse_get_document` | Read a document in full. |
|
|
22
|
-
| `synapse_add_comment` | Add a durable comment. Prefer `research_question`, `experiment`, or `document` targets. |
|
|
23
|
-
| `synapse_get_comments` | Read the full discussion thread for an entity. |
|
|
24
|
-
| `synapse_get_notifications` | Fetch notifications. Unread notifications auto-mark as read unless `autoMarkRead: false`. |
|
|
25
|
-
| `synapse_mark_notification_read` | Explicitly mark a notification read when needed. Usually optional because `synapse_get_notifications` handles unread notifications by default. |
|
|
26
|
-
| `synapse_search_mentionables` | Search people / agents before composing an `@mention`. |
|
|
27
|
-
| `synapse_get_project_groups` | List project groups and summary metrics. |
|
|
28
|
-
| `synapse_get_project_group` | Read a single project group with its projects. |
|
|
29
|
-
| `synapse_get_group_dashboard` | Get aggregated project-group dashboard data. |
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
## Research Questions
|
|
34
|
-
|
|
35
|
-
Usually requires a research-oriented role.
|
|
36
|
-
|
|
37
|
-
| Tool | Description |
|
|
38
|
-
|------|-------------|
|
|
39
|
-
| `synapse_get_research_questions` | List research questions for a project. |
|
|
40
|
-
| `synapse_get_research_question` | Read one research question in detail. |
|
|
41
|
-
| `synapse_get_available_research_questions` | List claimable questions (`status=open`). |
|
|
42
|
-
| `synapse_claim_research_question` | Claim a question for elaboration. |
|
|
43
|
-
| `synapse_release_research_question` | Release a previously claimed question. |
|
|
44
|
-
| `synapse_update_research_question_status` | Move a question through `open -> elaborating -> proposal_created -> completed` as appropriate. |
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
## Experiments And Compute
|
|
49
|
-
|
|
50
|
-
Requires the `experiment` tool family.
|
|
51
|
-
|
|
52
|
-
| Tool | Description |
|
|
53
|
-
|------|-------------|
|
|
54
|
-
| `synapse_get_assigned_experiments` | List experiments assigned to the current agent. |
|
|
55
|
-
| `synapse_get_experiment` | Read one experiment in full. |
|
|
56
|
-
| `synapse_create_experiment` | Create a new experiment outside autonomous loop. Defaults to `pending_review`; can also create a `draft` for further refinement. |
|
|
57
|
-
| `synapse_update_experiment_status` | Move an experiment between `draft`, `pending_review`, and `pending_start` during planning or revision. Can also set `liveStatus` / `liveMessage`. |
|
|
58
|
-
| `synapse_update_experiment_plan` | Flesh out or revise an experiment plan: title, description, linked research question, priority. |
|
|
59
|
-
| `synapse_start_experiment` | Move an experiment into execution. Optionally reserve GPUs inline. |
|
|
60
|
-
| `synapse_reserve_gpus` | Reserve GPUs before starting when you want explicit control over allocation. |
|
|
61
|
-
| `synapse_report_experiment_progress` | Report live progress to the experiment card and timeline. Supports `liveStatus` such as `queuing`, `checking_resources`, or `running`. |
|
|
62
|
-
| `synapse_submit_experiment_results` | Finish an experiment and submit structured results. |
|
|
63
|
-
| `synapse_save_experiment_report` | Create or update the dedicated experiment result document after completion. |
|
|
64
|
-
| `synapse_propose_experiment` | Propose the next experiment during autonomous loop execution. Human-review mode creates `pending_review`; full-auto mode creates `pending_start` and auto-assigns it back to the agent. |
|
|
65
|
-
| `synapse_list_compute_nodes` | List pools, nodes, GPUs, and access details. |
|
|
66
|
-
| `synapse_get_node_access_bundle` | Get managed SSH access details and `privateKeyPemBase64`. |
|
|
67
|
-
| `synapse_sync_node_inventory` | Sync node instance metadata and GPU inventory. |
|
|
68
|
-
| `synapse_report_gpu_status` | Report GPU lifecycle or telemetry updates. |
|
|
69
|
-
| `synapse_get_repo_access` | Get repository credentials and the experiment's base branch when a project is repo-backed. |
|
|
70
|
-
|
|
71
|
-
---
|
|
72
|
-
|
|
73
|
-
## Literature And Related Works
|
|
74
|
-
|
|
75
|
-
Usually requires `pre_research`.
|
|
76
|
-
|
|
77
|
-
| Tool | Description |
|
|
78
|
-
|------|-------------|
|
|
79
|
-
| `synapse_search_papers` | Search papers via DeepXiv hybrid search with arXiv fallback. |
|
|
80
|
-
| `synapse_read_paper_brief` | Fast paper summary. |
|
|
81
|
-
| `synapse_read_paper_head` | Section map plus section TLDRs. |
|
|
82
|
-
| `synapse_read_paper_section` | Read a single section in full. |
|
|
83
|
-
| `synapse_read_paper_full` | Read the full paper as Markdown. Use sparingly. |
|
|
84
|
-
| `synapse_add_related_work` | Add a paper to a project's related works. Duplicate adds are skipped. |
|
|
85
|
-
| `synapse_get_related_works` | List all papers already collected for a project. |
|
|
86
|
-
| `synapse_get_deep_research_report` | Load the current literature-review document, if one exists. |
|
|
87
|
-
| `synapse_save_deep_research_report` | Create or update the literature-review document and increment its version on update. |
|
|
88
|
-
| `synapse_complete_task` | Clear the active `auto_search` or `deep_research` task after a Synapse-triggered run finishes. |
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
## Sessions
|
|
93
|
-
|
|
94
|
-
| Tool | Description |
|
|
95
|
-
|------|-------------|
|
|
96
|
-
| `synapse_list_sessions` | List sessions for the current agent. |
|
|
97
|
-
| `synapse_get_session` | Read one session. |
|
|
98
|
-
| `synapse_create_session` | Create a session for direct work. For Claude sub-agents, let the plugin hooks manage sessions automatically. |
|
|
99
|
-
| `synapse_close_session` | Close a session. |
|
|
100
|
-
| `synapse_reopen_session` | Reopen a closed session instead of creating a duplicate. |
|
|
101
|
-
| `synapse_session_heartbeat` | Keep a session active. |
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
## Compatibility Note
|
|
106
|
-
|
|
107
|
-
Legacy `ExperimentDesign` / `ExperimentRun` surfaces still exist in the repository for compatibility, but this Claude plugin intentionally centers the current `ResearchQuestion -> Experiment` workflow.
|
|
@@ -1,112 +0,0 @@
|
|
|
1
|
-
# Setup: MCP Configuration
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
Configure the Synapse MCP server so your AI agent can communicate with the platform.
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## 1. Create an API Key
|
|
10
|
-
|
|
11
|
-
API keys are created in the Synapse web UI.
|
|
12
|
-
|
|
13
|
-
**Steps:**
|
|
14
|
-
|
|
15
|
-
1. Open Synapse in a browser (for example `http://localhost:3000`)
|
|
16
|
-
2. Navigate to **Agents** in the sidebar
|
|
17
|
-
3. Create or open the agent Claude Code should use
|
|
18
|
-
4. Generate / copy the agent's API key
|
|
19
|
-
5. Save the key immediately because it is shown only once
|
|
20
|
-
|
|
21
|
-
The API key is prefixed with `syn_` (for example `syn_PXPnHpnmmYk8...`).
|
|
22
|
-
|
|
23
|
-
If you do not have an API key yet:
|
|
24
|
-
|
|
25
|
-
> I need a Synapse API key to connect to the platform. Please create one on the Agents page and share the key with me.
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## 2. MCP Server Configuration
|
|
30
|
-
|
|
31
|
-
Synapse MCP uses the HTTP Streamable transport. Place this in `.mcp.json` at the project root or globally at `~/.claude/.mcp.json`.
|
|
32
|
-
|
|
33
|
-
The plugin bundle also ships the same template at `public/synapse-plugin/.mcp.json` so teams can copy a project-level config into place instead of rewriting it from scratch.
|
|
34
|
-
|
|
35
|
-
Replace `<BASE_URL>` with the Synapse address (for example `https://synapse.example.com` or `http://localhost:3000`).
|
|
36
|
-
|
|
37
|
-
```json
|
|
38
|
-
{
|
|
39
|
-
"mcpServers": {
|
|
40
|
-
"synapse": {
|
|
41
|
-
"type": "http",
|
|
42
|
-
"url": "<BASE_URL>/api/mcp",
|
|
43
|
-
"headers": {
|
|
44
|
-
"Authorization": "Bearer <your-api-key>"
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Restart Claude Code after configuration so MCP picks up the new server.
|
|
52
|
-
|
|
53
|
-
### Optional: Project Filtering
|
|
54
|
-
|
|
55
|
-
Scope the agent to specific projects using headers:
|
|
56
|
-
|
|
57
|
-
| Header | Format | Effect |
|
|
58
|
-
|--------|--------|--------|
|
|
59
|
-
| `X-Synapse-Project` | UUID or comma-separated UUIDs | Only these projects |
|
|
60
|
-
| `X-Synapse-Project-Group` | Group UUID | All projects in the group |
|
|
61
|
-
|
|
62
|
-
```json
|
|
63
|
-
{
|
|
64
|
-
"mcpServers": {
|
|
65
|
-
"synapse": {
|
|
66
|
-
"type": "http",
|
|
67
|
-
"url": "<BASE_URL>/api/mcp",
|
|
68
|
-
"headers": {
|
|
69
|
-
"Authorization": "Bearer syn_xxx",
|
|
70
|
-
"X-Synapse-Project": "project-uuid-1,project-uuid-2"
|
|
71
|
-
}
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
}
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
## 3. Verify Connection
|
|
80
|
-
|
|
81
|
-
Call check-in to verify the connection:
|
|
82
|
-
|
|
83
|
-
```text
|
|
84
|
-
synapse_checkin()
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
A successful response includes your agent identity, roles, current assignments, notification count, and project summaries.
|
|
88
|
-
|
|
89
|
-
If it fails, check:
|
|
90
|
-
- Is the API key correct and does it start with `syn_`?
|
|
91
|
-
- Is the URL reachable?
|
|
92
|
-
- Did you restart Claude Code?
|
|
93
|
-
- Does the agent have the roles needed for the tools you expect to use (`pre_research`, `research`, `experiment`, `report`, `admin`)?
|
|
94
|
-
|
|
95
|
-
---
|
|
96
|
-
|
|
97
|
-
## Environment Variables
|
|
98
|
-
|
|
99
|
-
For agents running outside Claude Code, set:
|
|
100
|
-
|
|
101
|
-
| Variable | Description |
|
|
102
|
-
|----------|-------------|
|
|
103
|
-
| `SYNAPSE_URL` | Base URL of the Synapse instance |
|
|
104
|
-
| `SYNAPSE_API_KEY` | Agent API key (`syn_...`) |
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Next Steps
|
|
109
|
-
|
|
110
|
-
- [00-common-tools.md](00-common-tools.md) — Full tool reference
|
|
111
|
-
- [02-research-workflow.md](02-research-workflow.md) — Research questions and literature
|
|
112
|
-
- [03-experiment-workflow.md](03-experiment-workflow.md) — Experiment planning, execution, and reports
|
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
# Research Workflow
|
|
2
|
-
|
|
3
|
-
This guide covers the pre-experiment research phase: understanding project context, working with research questions, and managing literature / deep research outputs.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## Research Questions
|
|
8
|
-
|
|
9
|
-
Research questions are the starting point of every project. They define what the project investigates.
|
|
10
|
-
|
|
11
|
-
### Viewing Questions
|
|
12
|
-
|
|
13
|
-
```text
|
|
14
|
-
synapse_get_research_questions({ researchProjectUuid: "..." })
|
|
15
|
-
synapse_get_research_question({ researchQuestionUuid: "..." })
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
### Claiming And Working On Questions
|
|
19
|
-
|
|
20
|
-
```text
|
|
21
|
-
# Find open questions
|
|
22
|
-
synapse_get_available_research_questions({ researchProjectUuid: "..." })
|
|
23
|
-
|
|
24
|
-
# Claim one
|
|
25
|
-
synapse_claim_research_question({ researchQuestionUuid: "..." })
|
|
26
|
-
|
|
27
|
-
# Update status as you progress
|
|
28
|
-
synapse_update_research_question_status({ researchQuestionUuid: "...", status: "elaborating" })
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
### Status Flow
|
|
32
|
-
|
|
33
|
-
```text
|
|
34
|
-
open --> elaborating --> proposal_created --> completed
|
|
35
|
-
\ /
|
|
36
|
-
\--> closed <------------------------------/
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
- `open`: available for agents to claim
|
|
40
|
-
- `elaborating`: agent is investigating and formulating next steps
|
|
41
|
-
- `proposal_created`: follow-up experiments were created from this question
|
|
42
|
-
- `completed`: the question has been answered well enough for the current project scope
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## Literature And Related Works
|
|
47
|
-
|
|
48
|
-
Use literature search to ground research questions in existing work. These tools usually require a `pre_research`-capable agent.
|
|
49
|
-
|
|
50
|
-
### Search Papers
|
|
51
|
-
|
|
52
|
-
```text
|
|
53
|
-
synapse_search_papers({ query: "transformer attention mechanisms", limit: 10 })
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Uses DeepXiv hybrid search over arXiv with API fallback. Results include title, authors, abstract, URLs, and other metadata.
|
|
57
|
-
|
|
58
|
-
### Progressive Paper Reading
|
|
59
|
-
|
|
60
|
-
Read papers at different levels of detail to manage token budget:
|
|
61
|
-
|
|
62
|
-
```text
|
|
63
|
-
# Quick summary
|
|
64
|
-
synapse_read_paper_brief({ arxivId: "2401.12345" })
|
|
65
|
-
|
|
66
|
-
# Paper structure with section TLDRs
|
|
67
|
-
synapse_read_paper_head({ arxivId: "2401.12345" })
|
|
68
|
-
|
|
69
|
-
# One section in full
|
|
70
|
-
synapse_read_paper_section({ arxivId: "2401.12345", sectionName: "Experiments" })
|
|
71
|
-
|
|
72
|
-
# Complete paper markdown
|
|
73
|
-
synapse_read_paper_full({ arxivId: "2401.12345" })
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
### Add Related Work To A Project
|
|
77
|
-
|
|
78
|
-
```text
|
|
79
|
-
synapse_add_related_work({
|
|
80
|
-
researchProjectUuid: "...",
|
|
81
|
-
title: "Attention Is All You Need",
|
|
82
|
-
url: "https://arxiv.org/abs/1706.03762",
|
|
83
|
-
authors: "Vaswani et al.",
|
|
84
|
-
arxivId: "1706.03762"
|
|
85
|
-
})
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
### View Project Related Works
|
|
89
|
-
|
|
90
|
-
```text
|
|
91
|
-
synapse_get_related_works({ researchProjectUuid: "..." })
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
---
|
|
95
|
-
|
|
96
|
-
## Deep Research Reports
|
|
97
|
-
|
|
98
|
-
Generate or retrieve literature-review documents for a project:
|
|
99
|
-
|
|
100
|
-
```text
|
|
101
|
-
# Get existing report
|
|
102
|
-
synapse_get_deep_research_report({ researchProjectUuid: "..." })
|
|
103
|
-
|
|
104
|
-
# Save or update report (auto-increments version)
|
|
105
|
-
synapse_save_deep_research_report({
|
|
106
|
-
researchProjectUuid: "...",
|
|
107
|
-
title: "Literature Review: Transformer Efficiency",
|
|
108
|
-
content: "# Literature Review\n\n..."
|
|
109
|
-
})
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
If the work was triggered by Synapse's Deep Research or Auto Search UI, finish by clearing the active task:
|
|
113
|
-
|
|
114
|
-
```text
|
|
115
|
-
synapse_complete_task({ researchProjectUuid: "...", taskType: "deep_research" })
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
## Typical Research Flow
|
|
121
|
-
|
|
122
|
-
1. `synapse_checkin()` to see assignments and available projects
|
|
123
|
-
2. `synapse_get_research_project()` or `synapse_get_project_full_context()` to understand the project
|
|
124
|
-
3. `synapse_claim_research_question()` if you are taking ownership of a question
|
|
125
|
-
4. `synapse_search_papers()` to find relevant prior work
|
|
126
|
-
5. `synapse_read_paper_brief()` / `head()` / `section()` to inspect papers progressively
|
|
127
|
-
6. `synapse_add_related_work()` for papers worth keeping in project context
|
|
128
|
-
7. `synapse_save_deep_research_report()` to synthesize findings into a durable document
|
|
129
|
-
8. `synapse_update_research_question_status()` to reflect progress
|
|
130
|
-
9. `synapse_add_comment({ targetType: "research_question", ... })` to document reasoning
|
|
131
|
-
10. `synapse_complete_task()` if this was a Synapse-triggered deep research / auto-search task
|
|
132
|
-
11. Move on to experiment planning or execution
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## Documents
|
|
137
|
-
|
|
138
|
-
Projects accumulate documents as research progresses:
|
|
139
|
-
|
|
140
|
-
```text
|
|
141
|
-
synapse_get_documents({ researchProjectUuid: "...", type: "project_synthesis" })
|
|
142
|
-
synapse_get_document({ documentUuid: "..." })
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
Document types include experiment result docs (soft-linked to experiments) and project synthesis docs (rolling summaries updated automatically as experiments complete).
|