Common Tasks

This page maps common goals to MCP payloads and CLI commands.

When to read this page: you know the task but not the tool name yet.

Related pages:

• Reference Home
• Tools Index

List notebooks

{ "action": "list" }

siyuan notebook list

Create a document

{
  "action": "create",
  "notebook": "<notebook-id>",
  "path": "/Inbox/Note",
  "markdown": "# Hello"
}

siyuan document create --notebook <notebook-id> --path "/Inbox/Note" --markdown "# Hello"

Append a block

{
  "action": "append",
  "parentID": "<doc-or-block-id>",
  "dataType": "markdown",
  "data": "New paragraph"
}

siyuan block append --parent-id <doc-or-block-id> --data-type markdown --data "New paragraph"

Search content

{
  "action": "fulltext",
  "query": "TODO"
}

siyuan search fulltext --query "TODO"

Read an attribute view

{
  "action": "get",
  "id": "<attribute-view-id>"
}

siyuan av get --id <attribute-view-id>