内容
# 涂鸦 MCP 📝
一款用于读取、搜索和写入 markdown 大型语言模型维基知识库的轻量级 MCP 服务器。专为需要持久化知识存储的大型语言模型代理设计。
https://github.com/chiam-ck/scribble-mcp
## 功能
| 工具 | 描述 |
|------|-------------|
| `vault_list` | 列出笔记，可选按类型（概念、实体、比较、查询、原始）筛选 |
| `vault_read` | 按精确路径或通配符模式读取笔记 |
| `vault_search` | 跨所有 markdown 文件进行全文搜索，并提供片段 |
| `vault_create` | 创建具有适当 YAML 前置信息和日期前缀文件名的新笔记 |
| `vault_append` | 将内容追加到现有笔记，自动更新 `updated` 日期 |
## 快速开始
```bash
# 安装
git clone https://github.com/chiam-ck/scribble-mcp.git
cd scribble-mcp
uv venv && source .venv/bin/activate && uv pip install -e .
# 作为标准输入输出 MCP 服务器运行
python -m scribble_mcp
# 或运行 HTTP 服务器（用于 webhook 集成）
python vault_api.py
```
### 克劳德桌面 / 克劳德代码
将以下内容添加到您的 MCP 配置中：
```json
{
"mcpServers": {
"scribble-wiki": {
"command": "python3",
"args": ["-m", "scribble_mcp"],
"cwd": "/path/to/scribble-mcp"
}
}
}
```
## 配置
复制 `.env.example` 到 `.env` 并自定义：
| 变量 | 默认值 | 描述 |
|----------|---------|-------------|
| `VAULT_API_PORT` | `8999` | HTTP 服务器端口（仅在 webhook 模式下使用） |
| `VAULT_API_HOST` | `0.0.0.0` | HTTP 服务器绑定地址 |
| `VAULT_PATH` | `~/vault/wiki` | 您的 markdown 维基知识库路径 |
## 知识库结构
知识库期望一个按类型组织的 markdown 文件目录：
```
wiki/
├── concepts/ # 知识主题
├── entities/ # 命名事物（人、项目、地点）
├── comparisons/ # 并排分析
├── queries/ # 已保存的问答对
└── raw/ # 源材料
```
文件遵循命名约定 `YYYY-MM-DD-descriptive-slug.md`，并具有 YAML 前置信息：
```yaml
---
title: 页面标题
created: 2025-01-01
updated: 2025-01-01
type: concept
tags: [tag1, tag2]
sources: []
---
```
## HTTP API（Webhook 模式）
用于与 n8n 或其他无法运行标准输入输出 MCP 的平台集成：
```
GET /health — 健康检查
GET /list?type=X — 按类型列出笔记
GET /read?path=X — 读取特定笔记
GET /search?q=X — 全文搜索
POST /create — 创建笔记（JSON 正文）
POST /append — 追加到笔记（JSON 正文）
POST / — 旧格式（操作/目录/查询/路径/内容）
```
## 许可证
MIT
