Doc Guard Free

SKILL.md

---
slug: doc-guard-free
name: doc-guard-free
version: 1.0.0
displayName: 文档护盾免费版
summary: 端到端加密 Markdown 文档协作工具，支持创建、查询、同步加密笔记，适合个人隐私场景。
license: Proprietary
edition: free
description: 文档护盾免费版面向个人开发者与隐私敏感用户，提供端到端加密的 Markdown 文档管理能力。核心覆盖文档创建、读取、更新、列表查询与基础搜索五大场景，所有内容在客户端加密后才同步到去中心化存储，确保即使服务端被攻破也无法读取明文。Use
  when 需要数据库操作、SQL查询、数据存储管理时使用。不适用于数据库架构设计决策。
tags:
- 集成工具
- 安全
- 隐私
tools:
- - read
- exec
homepage: https://skillhub.cn
pricing_tier: L3
pricing_model: per_use
suggested_price: 29.9
tools: ["read", "write", "exec"]
tags: "工具,效率,自动化"
---
# 文档护盾（免费版）

本 Skill 提供端到端加密的 Markdown 文档管理能力，让用户与 AI Agent 在不泄露明文的前提下协作。免费版覆盖日常个人使用场景，支持创建、读取、更新、列表、搜索五大核心操作。

## 概述

明文笔记应用存在两大风险：服务端被攻破后所有内容暴露；运营方可以"为了功能优化"读取用户数据。文档护盾采用客户端加密策略——用户密钥永不离开本地，所有内容在写入前先加密，读取时由客户端解密。即使服务端数据库全部泄露，攻击者也只能看到无意义的密文。

文档通过 `docId` 标识，每个文档有唯一的加密密钥片段（包含在分享链接的 `#` 锚点中），不掌握密钥的访问者无法解密。

## 核心能力

| 能力模块 | 输入 | 输出 | 说明 |
|----|---|---|---|
| 创建文档 | 标题 + 内容 | docId + 加密链接 | 自动加密并同步 |
| 读取文档 | docId | 完整内容 | 仅持有密钥可解密 |
| 更新文档 | docId + 新内容 | 更新后版本 | 增量版本管理 |
| 列表文档 | limit + skip | 文档列表 | 分页浏览 |
| 搜索文档 | 关键词 | 匹配结果 | 基于加密索引 |
| 删除文档 | docId | 确认消息 | 不可恢复 |
**技术实现要点**：核心能力基于`input_params`参数与`output_format`配置实现,支持创建/查询/修改/删除等操作模式,通过`config_options`进行运行时配置。

### 核心功能执行
用`input_params`参数进行配置。

**输入**: 用户提供核心功能执行所需的指令和必要参数。
**处理**: 解析核心功能执行的输入参数,完成核心逻辑,返回结构化响应。
**输出**: 返回核心功能执行的响应数据,包含状态码、结果和日志。
- 执行此能力时使用`input_params`参数,支持创建/查询/导出操作

### 参数配置与调用
用`config_options`参数进行配置。

**输入**: 用户提供参数配置与调用所需的指令和必要参数。
**处理**: 解析参数配置与调用的输入参数,完成核心逻辑,返回结构化响应。
**输出**: 返回参数配置与调用的响应数据,包含状态码、结果和日志。
- 执行此能力时使用`config_options`参数,支持修改/重置/导入操作

### 结果处理与输出
用`output_format`参数进行配置。

**输入**: 用户提供结果处理与输出所需的指令和必要参数。
**处理**: 解析结果处理与输出的输入参数,完成核心逻辑,返回结构化响应。
**输出**: 返回结果处理与输出的响应数据,包含状态码、结果和日志。
- 执行此能力时使用`output_format`参数,支持导出/保存/转换操作
**能力覆盖范围**：本skill的核心能力覆盖以下场景关键词：端到端加密、Markdown、文档协作工具、同步加密笔记、适合个人隐私场景、文档护盾免费版面、向个人开发者与隐、私敏感用户、提供端到端加密的、文档管理能力、核心覆盖文档创建、列表查询与基础搜、索五大场景、所有内容在客户端、加密后才同步到去、中心化存储、确保即使服务端被、攻破也无法读取明、Use、when、需要数据库操作、SQL、数据存储管理时使、不适用于数据库架、构设计决策等。这些关键词对应description中声明的使用场景,均已在上述能力点中提供对应的操作支持。

## 使用场景

### 场景一：个人隐私笔记（个人角色）
记录日记、健康数据、家庭账目等敏感信息。通过端到端加密确保即使账号被盗，攻击者也无法解密历史文档。

### 场景二：跨设备同步（移动办公角色）
在手机上记录想法，回到桌面后继续编辑。所有内容自动加密同步，无需手动配置同步盘。

### 场景三：Agent 协作上下文（开发者角色）
让 AI Agent 在加密文档上工作——Agent 可读取、更新文档，但服务端只看到密文操作。适合需要让 AI 处理敏感业务文档但又担心数据泄露的场景。

### 场景四：合规审计（合规角色）
满足隐私法规（GDPR、PIPL 等）对数据存储加密的要求。所有内容默认加密存储，无需额外配置。

## 快速开始

1. 阅读## 核心能力章节了解skill功能
2. 按## 依赖说明配置环境
3. 执行所需能力对应的命令
4. 参考## 错误处理章节处理异常
5. 查看## FAQ解答常见疑问

### 通过 MCP工具协议接入

#### Claude Code 接入

```bash
claude mcp add --transport http doc-guard-api <SERVER_URL>
```

#### Cursor 接入

将以下配置写入 `~/.cursor/config/mcp.json`：

```json
{
  "mcpServers": {
    "doc-guard-api": {
      "type": "streamable-http",
      "url": "<SERVER_URL>"
    }
  }
}
```

#### Windsurf 接入

将相同的 MCP server 配置写入 Windsurf 的 MCP 工具配置文件即可。

### 示例

```
# 创建加密文档
"帮我创建一份加密文档，标题：周会纪要，内容：..."
# ...
# 列出所有文档
"列出我最近 10 份加密文档"
# ...
# 搜索文档
"搜索包含'API设计'的文档"
# ...
# 更新文档
"更新文档 abc123，把第二段改成..."
# ...
# 删除文档
"删除文档 abc123"
```

**响应解析**: 完成完成后,查看输出响应确认任务状态。成功时输出包含解析摘要和响应数据;失败时根据错误信息排查问题,查阅错误解析章节获取恢复步骤。

## 配置示例

### 创建文档的标准调用

```json
{
  "tool": "create_document",
  "params": {
    "title": "周会纪要 2026-07",
    "content": "# 周会纪要\n\n## 议题\n1. 版本发布节奏\n2. 性能优化方案\n\n## 决议\n- 下周冻结代码\n- 性能目标 P99 < 200ms"
  }
}
```

返回示例：

```json
{
  "docId": "abc123",
  "title": "周会纪要 2026-07",
  "syncStatus": "synced",
  "link": "https://example.com/d/abc123#encryptionKey"
}
```

### 列表分页

```json
{
  "tool": "list_documents",
  "params": { "limit": 10, "skip": 0 }
}
```

## 最佳实践

1. **始终返回分享链接**：创建或更新文档后，把 `link` 字段返回给用户，方便分享与跨设备查看。
2. **先搜索再创建**：用户提到更新需求时，先搜索是否已有同名文档，避免重复。
3. **处理同步失败**：若 `syncStatus` 为 `failed`，调用重试工具并告知用户。
4. **分页加载**：列表场景使用 `skip` 与 `limit` 分页，避免一次性载入全部。
5. **内容用 Markdown**：内容字段支持完整 Markdown 语法，应使用标题、列表、表格组织结构。
6. **轮询同步状态**：创建后若 `syncStatus` 为 `pending`，应轮询直到 `synced` 再返回链接。
7. **删除前确认**：删除操作不可恢复，应在执行前向用户二次确认。

## 常见问题

### Q1：分享链接里的 `#encryptionKey` 是什么？
A：链接锚点 `#` 后跟的是加密密钥片段。访问者必须持有完整链接（含锚点）才能解密，截断链接会导致无法解密。

### Q2：同步状态一直停在 pending 怎么办？
A：免费版同步超时上限为 60 秒，超时后可调用 `get_sync_status` 轮询。若长期失败，可能是去中心化存储网络限流，稍后重试。

### Q3：能搜索加密文档的内容吗？
A：可以。系统在客户端生成加密索引，搜索时由客户端解密索引后比对，服务端无法看到搜索关键词。

### Q4：删除文档后能恢复吗？
A：不能。删除是不可逆操作，会同时清除本地与去中心化存储中的记录。建议重要文档删除前先导出备份。

### 已知限制
A：免费版不限制文档数量，但同步速度受网络与去中心化存储速率影响，单文件最大 10MB。
- 当前为免费版本,如需完整功能请升级到付费版获取全部能力
## 依赖说明

### 运行环境
- **Agent 平台**：支持 SKILL.md 与 MCP工具协议的 AI Agent（Claude Code / Cursor / Windsurf 等）
- **操作系统**：Windows / macOS / Linux
- **浏览器**：现代浏览器（用于查看分享链接）

### 依赖详情
| 依赖项 | 类型 | 是否必需 | 获取方式 |
|:-----|:-----|:-----|:-----|
| LLM API | API | 必需 | 由 Agent 平台内置 LLM 提供 |
| MCP工具客户端 | 协议适配 | 必需 | Agent 客户端自带 |
| 加密文档服务端 | 后端服务 | 必需 | 自建或托管，需提供 `<SERVER_URL>` |
| 去中心化存储 | 存储层 | 必需 | 内置于服务端，对外透明 |

### API Key 配置
- 本 Skill 通过 MCP工具协议接入，无需单独 API Key
- 服务端 `<SERVER_URL>` 由用户自行部署或选择托管方案
- 用户密钥片段由客户端本地生成与保管，不上传服务端
- 禁止在 SKILL.md 或脚本中硬编码任何密钥

### 可用性分类
- **分类**：MD+EXEC（纯 Markdown 指令，部分功能需要 exec 命令行执行能力）
- **说明**：基于 Markdown 的 AI Skill，通过 MCP工具协议与加密文档服务端通信

## 免费版限制

本免费体验版限制以下高级功能：
- 批量文档操作（一次仅支持单文档处理）
- 文档版本回滚（仅保留最新版本）
- 自定义加密策略（仅提供默认 AES-256-GCM）
- 团队协作与权限管理（仅个人使用）
- 文档模板与自动化流水线
- 优先同步队列（受网络速率影响）

解锁全部功能请使用专业版：doc-guard-pro

## 错误处理

| 错误场景 | 原因 | 处理方式 |
|---:|---:|---:|
| 配置错误 | 参数缺失或格式错误 | 检查依赖说明中的配置要求 |
| 运行时错误 | 运行环境不满足 | 确认运行环境符合依赖说明 |
| 网络错误 | 连接超时或不可达 | 执行ping命令测试网络连通性,检查防火墙和代理设置连接后执行ping命令测试网络连通性,检查防火墙和代理设置连接后重新执行命令，参考国内替代方案 |