siyuan-notes

Search and retrieve content from SiYuan notes via full-text and SQL queries.

53|8|Updated Dec 19, 2025
One-click install
npx skills add https://github.com/2234839/siyuan-notes-skill --skill siyuan-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: siyuan-notes
Source: https://github.com/2234839/siyuan-notes-skill/tree/main
Command: npx skills add https://github.com/2234839/siyuan-notes-skill --skill siyuan-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Users struggle to locate specific information across large SiYuan knowledge bases, requiring manual browsing and copy‑pasting.

Core Features & Use Cases

  • Full‑text Search: Quickly find blocks containing keywords with optional type filters.
  • SQL Queries: Run advanced queries on the SiYuan database to extract structured data.
  • Block & Asset Retrieval: Get markdown content of any block and download associated assets locally.
  • Use Case: A researcher can query “latest experiment results” and receive the top matching notes together with any related images.

Quick Start

Ask the skill to search my SiYuan notes for “project plan” and show the top results.

Frequently Asked Questions about siyuan-notes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search for keywords across my SiYuan knowledge base?

To search your SiYuan knowledge base, this tool performs full-text search to instantly find blocks containing your target keywords. It optionally applies type filters to narrow down the matching note blocks.

Can I run SQL queries to extract structured data from SiYuan notes?

Yes, you can run advanced SQL queries directly on the SiYuan database to extract structured data. This allows you to filter and retrieve specific block information based on your custom query logic.

How do I retrieve specific block content and download associated assets from SiYuan?

You can retrieve the markdown content of any block and download associated assets locally. Specify the block identifier to instantly fetch its content and save related images or files.

Do I need a SiYuan API token to search and retrieve notes?

Yes, you need a SiYuan API token to connect to your SiYuan server and authenticate search requests. Optional basic authentication and environment configuration are also supported for access.

What is the best way to find matching notes and images for a research topic?

The best way to find research notes is using full-text search to query keywords like "latest experiment results". This returns top matching notes together with any related images.

Why does my SiYuan note retrieval only return partial block content?

Note retrieval returns partial content when block type filters restrict results or when the SQL query limits the selected fields. Adjust your query parameters to fetch the full markdown block.