Introduction¶
DeepSeek Harness (DSH) extends its functionality through a plugin mechanism, and integrating local knowledge bases is a common requirement. The dsh-siyuan plugin addresses the issue of connecting SiYuan Notes to DSH, allowing the model to directly search, read, and write the user’s note library.
Plugin Overview¶
The plugin name is yoursc/dsh-siyuan, authored by yoursc, categorized under Knowledge Base and Web UI, and licensed under MIT.
The core value of this plugin is providing 17 siyuan_* tools (covering search, read, write, move, delete, diary, and attributes), along with a standalone settings page for managing connection, permissions, and the default notebook.
Installation¶
Install the plugin using the following command:
dsh plugin --profile web add @yoursc/dsh-siyuan
Configuration¶
After installation, locate the “SiYuan Notes” card on the DSH settings page. This settings page contains four independent cards, each storing:
- Connection: Configure the SiYuan address (default
http://127.0.0.1:6806). - API token: Copy and paste it from SiYuan Settings -> About -> API token.
- Default notebook: Select the notebook to use by default.
- Tool switches: Manage tool permissions in four groups: read-only, write, diary, and dangerous.
The API token is stored in the host’s credential store, and the settings page will not echo or redisplay its value.
Usage Examples¶
- Copy the API token in SiYuan settings and save it on the plugin settings page.
- Use
siyuan_searchto search notes. - Use
siyuan_daily_noteto create or read a daily note. - Use
siyuan_create_docto create a new document. - Click “Test Connection” on the settings page to verify the configuration.
Notes¶
- Unofficial plugin: This plugin is not affiliated with the SiYuan Notes project.
- Version compatibility: DSH 0.1.7 users should use version 0.0.3 or later.
- Tool naming: Tool names are fixed as
siyuan_*; tools with the same name may shadow one another. - SQL restrictions: The SQL tool accepts only a single SELECT statement.
- Operation confirmation: Deletion and update operations undergo confirmation or verification to ensure they take effect.
- Permission defaults: Only the read-only and diary groups are enabled by default; the write and dangerous groups are disabled by default.
Conclusion¶
This plugin provides DSH users with a standardized knowledge base integration solution. Through a standalone settings page and fine-grained permission control, it lowers the barrier to integrating local note-taking systems. For more details, refer to the GitHub repository or the plugin directory.