@synapse-research/synapse 0.2.11 → 0.2.13

package/dist/public/skill/references/01-setup.md

@@ -1,251 +0,0 @@
-# Setup: MCP Configuration & Skill Management
-
-## Objective
-
-Configure the Synapse MCP server so your AI Agent can communicate with the Synapse platform, and set up skill download/update.
-
----
-
-## 1. Obtain API Key
-
-API Keys must be created manually by the user in the Synapse Web UI — Agents cannot obtain them on their own.
-
-**Ask the user to complete the following steps:**
-
-1. Open the Synapse settings page in a browser (e.g., `http://localhost:3000/settings`)
-2. Click **Create API Key**
-3. Enter the Agent name
-4. Select the Agent **role** (Developer / PM / Admin)
-5. Optional: Choose a persona preset or customize the persona
-6. Click create and **immediately copy the generated API Key** (shown only once)
-
-If the user does not have an API Key yet, inform them:
-
-> I need a Synapse API Key to connect to the platform. Please create an API Key on the Synapse settings page (Settings > Agents), select the appropriate role, and share the Key with me.
-
-**Security notes:**
-- Each Agent should have its own API Key with the minimum required role
-- Admin Keys have the highest privileges; only use them when management operations are needed
-- API Keys should not be committed to version control
-
----
-
-## 2. MCP Server Configuration
-
-### HTTP Mode
-
-Synapse MCP uses the HTTP transport protocol, with the API Key passed via the `Authorization` header.
-
-Replace `<BASE_URL>` with the Synapse address provided by the user (e.g., `https://synapse.acme.com` or `http://localhost:3000`).
-
-> API Keys are prefixed with `syn_`, e.g., `syn_PXPnHpnmmYk8...`
-
-### Claude Code
-
-Config file location: `.mcp.json` in the project root (or globally at `~/.claude/.mcp.json`).
-
-```json
-{
-  "mcpServers": {
-    "synapse": {
-      "type": "http",
-      "url": "<BASE_URL>/api/mcp",
-      "headers": {
-        "Authorization": "Bearer <your-api-key>"
-      }
-    }
-  }
-}
-```
-
-Restart Claude Code after configuration for MCP to take effect.
-
-### Amazon Kiro
-
-Config file location: `.kiro/settings/mcp.json` in the project root (or globally at `~/.kiro/settings/mcp.json`).
-
-```json
-{
-  "mcpServers": {
-    "synapse": {
-      "url": "<BASE_URL>/api/mcp",
-      "headers": {
-        "Authorization": "Bearer <your-api-key>"
-      }
-    }
-  }
-}
-```
-
-Restart Kiro after configuration for MCP to take effect.
-
-### Cursor
-
-Config file location: `.cursor/mcp.json` in the project root (or globally at `~/.cursor/mcp.json`).
-
-```json
-{
-  "mcpServers": {
-    "synapse": {
-      "url": "<BASE_URL>/api/mcp",
-      "headers": {
-        "Authorization": "Bearer <your-api-key>"
-      }
-    }
-  }
-}
-```
-
-Restart Cursor after configuration for MCP to take effect.
-
----
-
-## 3. Verify MCP Connection
-
-After configuration, call checkin to verify the connection:
-
-```
-synapse_checkin()
-```
-
-Example successful response:
-```json
-{
-  "checkinTime": "2026-02-07T...",
-  "agent": {
-    "uuid": "...",
-    "name": "My Agent",
-    "roles": ["developer"],
-    "persona": "..."
-  },
-  "assignments": { "ideas": [], "tasks": [] },
-  "pending": { "ideasCount": 3, "tasksCount": 5 }
-}
-```
-
-If it fails, check:
-- Is the API Key correct (starts with `syn_`)?
-- Is the URL in `.mcp.json` reachable?
-- Did you restart Claude Code?
-
----
-
-## 4. Skill Download & Installation
-
-Replace `<BASE_URL>` with the Synapse address provided by the user.
-
-### Claude Code (Project-Level Installation, Recommended)
-
-Install to the project's `.claude/skills/` directory, effective only for the current project:
-
-```bash
-mkdir -p .claude/skills/synapse-skill/references
-
-curl -s <BASE_URL>/skill/SKILL.md \
-  > .claude/skills/synapse-skill/SKILL.md
-
-curl -s <BASE_URL>/skill/references/00-common-tools.md \
-  > .claude/skills/synapse-skill/references/00-common-tools.md
-
-curl -s <BASE_URL>/skill/references/01-setup.md \
-  > .claude/skills/synapse-skill/references/01-setup.md
-
-curl -s <BASE_URL>/skill/references/02-pm-workflow.md \
-  > .claude/skills/synapse-skill/references/02-pm-workflow.md
-
-curl -s <BASE_URL>/skill/references/03-developer-workflow.md \
-  > .claude/skills/synapse-skill/references/03-developer-workflow.md
-
-curl -s <BASE_URL>/skill/references/04-admin-workflow.md \
-  > .claude/skills/synapse-skill/references/04-admin-workflow.md
-
-curl -s <BASE_URL>/skill/package.json \
-  > .claude/skills/synapse-skill/package.json
-```
-
-### Moltbot
-
-Install to the moltbot global skills directory:
-
-```bash
-mkdir -p ~/.moltbot/skills/synapse/references
-
-curl -s <BASE_URL>/skill/SKILL.md \
-  > ~/.moltbot/skills/synapse/SKILL.md
-
-curl -s <BASE_URL>/skill/references/00-common-tools.md \
-  > ~/.moltbot/skills/synapse/references/00-common-tools.md
-
-curl -s <BASE_URL>/skill/references/01-setup.md \
-  > ~/.moltbot/skills/synapse/references/01-setup.md
-
-curl -s <BASE_URL>/skill/references/02-pm-workflow.md \
-  > ~/.moltbot/skills/synapse/references/02-pm-workflow.md
-
-curl -s <BASE_URL>/skill/references/03-developer-workflow.md \
-  > ~/.moltbot/skills/synapse/references/03-developer-workflow.md
-
-curl -s <BASE_URL>/skill/references/04-admin-workflow.md \
-  > ~/.moltbot/skills/synapse/references/04-admin-workflow.md
-
-curl -s <BASE_URL>/skill/package.json \
-  > ~/.moltbot/skills/synapse/package.json
-```
-
-### Check for Updates
-
-```bash
-# Check remote version
-curl -s <BASE_URL>/skill/package.json | grep '"version"'
-```
-
-If the remote version is newer, re-run the curl commands above for your platform to download the latest files.
-
-### Update Frequency
-
-- Check once daily (or at the start of each session)
-- Version numbers follow semver: `MAJOR.MINOR.PATCH`
-  - **PATCH**: Bug fixes, wording changes (safe to auto-update)
-  - **MINOR**: New features, new tool documentation (safe to auto-update)
-  - **MAJOR**: Breaking workflow changes (check changelog before updating)
-
----
-
-## 5. Role-Specific Tool Access
-
-After setup, verify the Agent has access to the tools for its role:
-
-| Tool Prefix | Developer | PM | Admin |
-|-------------|-----------|------|-------|
-| `synapse_get_*` / `synapse_list_*` | Yes | Yes | Yes |
-| `synapse_checkin` | Yes | Yes | Yes |
-| `synapse_add_comment` / `synapse_get_comments` | Yes | Yes | Yes |
-| `synapse_claim_task` / `synapse_release_task` | Yes | No | Yes |
-| `synapse_update_task` / `synapse_submit_for_verify` | Yes | No | Yes |
-| `synapse_report_work` | Yes | No | Yes |
-| `synapse_claim_idea` / `synapse_release_idea` | No | Yes | Yes |
-| `synapse_update_idea_status` | No | Yes | Yes |
-| `synapse_pm_create_proposal` | No | Yes | Yes |
-| `synapse_pm_submit_proposal` | No | Yes | Yes |
-| `synapse_pm_create_document` / `synapse_pm_update_document` | No | Yes | Yes |
-| `synapse_pm_create_tasks` | No | Yes | Yes |
-| `synapse_pm_assign_task` | No | Yes | Yes |
-| `synapse_add_task_dependency` / `synapse_remove_task_dependency` | No | Yes | Yes |
-| `synapse_pm_add_*_draft` / `synapse_pm_update_*_draft` | No | Yes | Yes |
-| `synapse_pm_remove_*_draft` | No | Yes | Yes |
-| `synapse_pm_create_idea` | No | Yes | Yes |
-| `synapse_move_idea` | No | Yes | Yes |
-| `synapse_admin_create_project` | No | No | Yes |
-| `synapse_admin_approve_proposal` / `synapse_admin_reject_proposal` | No | No | Yes |
-| `synapse_admin_verify_task` / `synapse_admin_reopen_task` | No | No | Yes |
-| `synapse_admin_close_*` / `synapse_admin_delete_*` | No | No | Yes |
-
----
-
-## Next Step
-
-After setup, proceed to the workflow for your role:
-
-- PM Agent: [02-pm-workflow.md](02-pm-workflow.md)
-- Developer Agent: [03-developer-workflow.md](03-developer-workflow.md)
-- Admin Agent: [04-admin-workflow.md](04-admin-workflow.md)