The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Shinobi listing page.
The task spine for AI coding agents. Shinobi holds the decisions that survive across sessions, actively searches your past dead ends — semantically — before the agent writes code, and routes approvals to your phone. One brain, every device: laptop, cloud session, and mobile all wired to the same store.
Works with Claude Code, Cursor, Cline, Continue.dev, Zed — any MCP-compatible client.
Status: v0.3 — autonomous agents. Run it as a hosted HTTP
/mcpbrain (the default deploy) or self-host a local instance. Mobile push, a headless dispatch loop, parallel swarm over git worktrees, and audit→subtask ingestion on top of the remote MCP foundation. 39 MCP tools, web dashboard, mobile approvals, plugin system, optional semantic recall.
Most tools try to be a memory bolt-on. Shinobi is the task spine your agent works along — the durable backbone of work, decisions, and known-bad paths that outlives any single session and follows you across every device.
request_approval pushes the decision to your pocket; the agent blocks until you tap yes/no, wherever you arelink_commit ties commits to subtasks via [SHI-N] tags or via target_path attribution.js file in ~/.shinobi/plugins/ or install a @shinobi/plugin-* npm package and register custom plugin_* toolsHosted or self-hosted, your call. The default deploy is one remote brain
behind an HTTP /mcp endpoint (we run ours at shinobi.shinobi-apps.com); the
same binary still runs as a fully local single-machine instance when you'd
rather keep everything on your own box. BYO embedding provider only if you want
semantic recall.
🚀 New here? Follow Getting started — zero to a working brain in ten minutes. Going multi-device? Remote mode
Requirements:
PATHbetter-sqlite3 native build (most systems have prebuilt binaries; Windows may need Visual Studio Build Tools as fallback)The binary is shinobi (e.g. shinobi serve, shinobi dashboard).
Pulls from main. Useful for trying unreleased fixes. On Windows you may need
to add your Node directory to system PATH before this works, because the
prepare build script runs in a subshell that does not always inherit
per-session PATH (Laragon, portable installs). If install fails with 'node' is not recognized, prefer the npm install above.
In any project root where you want Shinobi available to your MCP client:
init will:
~/.shinobi/ with config.json, .env template, and shinobi.db (migrations applied).mcp.json snippet for the current projectshinobi init writes config for the two clients with a workspace-local
MCP convention out of the box:
<workspace>/.mcp.json<workspace>/.cursor/mcp.jsonRestart the client and the mcp__shinobi__* tools become available.
For other MCP clients (Cline, Continue.dev, Zed), see the MCP client setup section below.
Then open:
On Windows PowerShell, if script execution blocks shinobi, use the .cmd shim:
If you upgraded Node or copied an old node_modules, rebuild native dependencies:
Important: the code lives in the Shinobi folder, but the local memory database lives in:
To move the tool only, copy/clone the Shinobi folder and run the install commands above. To move the existing projects, tasks, decisions, notes, and context too, either copy ~/.shinobi/ or use shinobi sync.
Every snippet below uses the same JSON shape — command is the path
to the Node binary that's running Shinobi, args is [<absolute path to dist/cli.js>, "mcp"]. Print the exact values for your machine:
(Or read .mcp.json from any project where you already ran
shinobi init — the values are identical.)
Drops in automatically — shinobi init writes <workspace>/.mcp.json.
Restart Claude Code to pick up the server.
Drops in automatically — shinobi init writes <workspace>/.cursor/mcp.json.
Works on Cursor 0.43+. Restart Cursor or reload the workspace.
For a global Cursor config (every project sees Shinobi), paste the
same snippet into ~/.cursor/mcp.json (or use Cursor Settings → MCP).
Open Cline's settings file:
%APPDATA%\Code\User\globalStorage\saoudrizwan.claude-dev\settings\cline_mcp_settings.json~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.jsonMerge the contents of your project's .mcp.json into the file's
mcpServers object. Restart VS Code.
Edit ~/.continue/config.json. Add Shinobi to the mcpServers array
(note: Continue uses an array, not an object like the others):
Use the values from your project's .mcp.json for command and args.
Edit ~/.config/zed/settings.json. Zed nests MCP servers under
context_servers:
Restart Zed.
Any MCP client that supports the standard { command, args } server spec
should work. Use the same values your .mcp.json has:
command: absolute path to the Node binary running Shinobiargs: [<absolute path to dist/cli.js>, "mcp"]Avoid the bare shinobi command in MCP config — many clients spawn
servers with shell: false, which skips the OS PATH resolution that
makes shinobi work in a terminal.
Host one Shinobi brain on a server and connect every device to it — your
desktop editor, Claude Code web/mobile sessions, any remote-MCP-capable
client. shinobi serve exposes the MCP endpoint at /mcp (streamable HTTP,
stateless, bearer-token auth) alongside the dashboard:
This is the recommended way to run Shinobi — one brain, reachable from every device. The same binary still runs as a local single-machine instance if you'd rather self-host everything on your own box. Full deployment guide (Docker, Cloudflare Tunnel, GCP Always Free, client config): docs/remote-mcp.md.
| Group | Tools |
|---|---|
| Projects | list_projects, get_project, create_project, update_project, archive_project, unarchive_project, delete_project |
| Subtasks | list_tasks, get_task, create_task, bulk_create_tasks, update_subtask, delete_subtask, claim_task, complete_task, next_task |
| Decisions | log_decision, decisions_for_file, update_decision_status |
| Dead ends | log_dead_end, check_dead_ends |
| Notes | add_note, list_notes |
| Plans | save_plan, get_plan |
| Context | get_context, update_context |
| Recall | recall (FTS5 or semantic) |
| Timeline | history, link_commit |
| Workflow | agent_bootstrap, session_closeout, file_context |
| Extraction | extract_decisions, compress_session_summary |
| Approvals | request_approval |
| Notifications | notify |
| Findings | ingest_findings |
| Plugins | plugin_hello |
| Layer | Tech |
|---|---|
| Language | TypeScript (strict mode, ES2022, NodeNext) |
| Runtime | Node 18+ |
| MCP | @modelcontextprotocol/sdk 1.x |
| Storage | SQLite via better-sqlite3 (WAL mode) |
| Dashboard | Hono + @hono/node-server (same process, localhost:8765) |
| Embeddings (optional) | OpenAI text-embedding-3-small / Voyage voyage-3-lite / Ollama nomic-embed-text |
| Migrations | Forward-only, sha256 checksum, schema_migrations table |
See docs/architecture.md for the request lifecycle and module layout.
The dashboard is open on loopback binds (127.0.0.1, localhost, ::1) and token-protected on any non-loopback bind. The token is read from SHINOBI_DASHBOARD_TOKEN, otherwise loaded from ~/.shinobi/dashboard-token, otherwise auto-generated and persisted there. /health is always open for probes.
Browser flow — open the dashboard with the token once and the cookie sticks:
Curl / scripts — any of these works:
See docs/configuration.md for the full env-var reference.
Shinobi syncs your local SQLite database via a private git repo. Setup once per machine:
The DB file lands on the main branch as a binary; pre-existing local DB is backed up to <path>.bak-<timestamp> before restore.
Edit ~/.shinobi/.env or set env vars before running shinobi mcp:
| Variable | Default | Purpose |
|---|---|---|
SHINOBI_DB_PATH | ~/.shinobi/shinobi.db | SQLite location |
SHINOBI_CONFIG_DIR | ~/.shinobi | Config + plugins directory |
SHINOBI_PLUGINS_DIR | ${configdir}/plugins | Plugin discovery directory |
SHINOBI_DASHBOARD_PORT | 8765 | Dashboard port |
SHINOBI_DASHBOARD_HOST | 127.0.0.1 | Dashboard bind host. Loopback skips auth; non-loopback auto-enables token auth. |
SHINOBI_DASHBOARD_TOKEN | (auto) | Override the dashboard token; auto-generated to ~/.shinobi/dashboard-token when needed. |
SHINOBI_EMBED_PROVIDER | none | openai / voyage / ollama / none |
SHINOBI_EMBED_API_KEY | — | Auth for OpenAI / Voyage (else falls back to OPENAI_API_KEY / VOYAGE_API_KEY) |
SHINOBI_EMBED_MODEL | provider default | Override model id |
SHINOBI_EMBED_DIMS | provider default | Override dimensions |
SHINOBI_OLLAMA_URL | http://localhost:11434 | Ollama endpoint |
SHINOBI_MIGRATIONS_DIR | <package>/migrations | Override migrations source |
Full reference: docs/configuration.md.
Write a single .js file in ~/.shinobi/plugins/:
Restart the MCP client and mcp__shinobi__plugin_count_open is available. See docs/plugin-development.md.
/mcp endpoint,
Docker + GCP Always Free deploy, Cloudflare Tunnel, env-driven .mcp.json
for cloud sessions. One brain across laptop, cloud, and mobile.next_task and works
while you sleep) → Shinobi Swarm (N parallel agents, worktree isolation,
shared dead ends), plus ingest_findings (audit → subtask graph → swarm)
pulled forward from v0.4.tools/*; richer remediation templates
and finding-source adapters on top of ingest_findings.See CHANGELOG.md for release notes.
See CONTRIBUTING.md. Issues and PRs welcome.
By participating you agree to our Code of Conduct.
For vulnerability reports, see SECURITY.md — please do not open public issues for security matters.
MIT — see LICENSE.