Metadata-Version: 2.4
Name: siyuan-mcp
Version: 0.1.2
Summary: MCP service connecting Claude with Siyuan Note
Author-email: Niko <niko@siyuan-bridge.dev>
License-Expression: MIT
Project-URL: Homepage, https://github.com/qyzxcswbll/siyuan-bridge
Project-URL: Repository, https://github.com/qyzxcswbll/siyuan-bridge
Project-URL: Issues, https://github.com/qyzxcswbll/siyuan-bridge/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mcp>=1.0.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: httpx>=0.27
Requires-Dist: pydantic>=2.0
Requires-Dist: jieba>=0.42
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
Requires-Dist: pytest-httpx>=0.30; extra == "dev"
Requires-Dist: ruff>=0.4; extra == "dev"

# siyuan-mcp

连接 **Claude** 与 **[思源笔记](https://github.com/siyuan-note/siyuan)** 的 MCP 服务。

**v0.1.1 · [PyPI](https://pypi.org/project/siyuan-mcp/)**

## 工具

| 工具 | 功能 | 参数 |
|------|------|------|
| `sy-notebook` | 列出笔记本 | — |
| `sy-list` | 列出文档列表 | `notebook` |
| `sy-save` | 保存文档 | `content`, `notebook` |
| `sy-read` | 读取文档内容 | `id` |
| `sy-delete` | 删除文档 | `id`, `notebook` |
| `sy-find` | 搜索（思源+代码） | `query`, `mode` |

## 安装

```bash
pip install siyuan-mcp
```

### 注册到 Claude（一步）

```bash
siyuan-mcp-install
```

重启 VS Code 即可。

## 使用示例

```
sy-notebook                    → 列出所有笔记本
sy-list 临时使用               → 列出文档（含ID）
sy-save 把这段内容保存到思源    → 直接写入
sy-read siyuan://blocks/xxx    → 读取文档
sy-delete siyuan://blocks/xxx  → 删除文档
sy-find OAuth2                 → 搜索
sy-find fn main mode=code      → 代码搜索
```

## 配置

```bash
cp config.yaml.example config.yaml
# 填入 siyuan.token
```

## 开发

```bash
pip install -e ".[dev]"
pytest -v
python -m siyuan_mcp
```

## 设计原则

参考 obsidian-mcp 的低层级设计哲学：**每个工具只做一件事，不做猜测。** AI 负责内容生成，MCP 负责内容存储。

## 许可证

MIT
