SiYuan Sisyphus MCP & CLI Docs

SiYuan Sisyphus MCP & CLI exposes SiYuan capabilities in two forms:

• A SiYuan plugin with an embedded MCP server
• A standalone CLI: siyuan-sisyphus

Choose Your Path

I want to use it with an AI client

Start here:

• Getting Started
• Then verify with a read-only call from Common Tasks

Use this path if you are connecting Claude Desktop, Codex, Cherry Studio, Cursor, Cline, or another MCP client.

I want to use the CLI directly

Start here:

• Getting Started
• Common Tasks

Use this path if you want one-shot terminal commands such as siyuan notebook list.

I want to contribute to the project

Start here:

• Architecture
• Development

Use this path if you need to change tool handlers, API wrappers, build targets, or docs.

Recommended Reading Order

1. Getting Started
2. Reference
3. Architecture
4. Development

What This Project Contains

• 11 aggregated tools with action-level routing
• Notebook-level permission control: none, r, rw, rwd
• HTTP and stdio transport modes
• A shared implementation used by both MCP and CLI entrypoints

Related Pages

• Project README
• 中文文档
• Architecture Notes