用于查询、浏览和阅读 M-Doc 文档系统的 Claude Code 技能。

English

---

mdoc-skills 为 Claude Code 添加了 mdoc 技能。安装后，你可以直接将任意 mdoc.cc URL 或 orgSlug/docSlug 短路径粘贴到提示词中，Claude 会自动向 M-Doc OpenAPI 发起认证请求，获取文档目录或文章内容并内联展示。

以下情况会触发本技能：

• 粘贴 https://mdoc.cc/… 格式的 URL
• 输入短路径，如 mliev/mdoc 或 mliev/mdoc/v1.0.0/32
• 说出"列出文档"、"读取文章"、"获取目录清单"、"调用 mdoc api" 等指令

---

• 自动解析 mdoc.cc URL 及 org/doc[/version[/articleId]] 短路径
• 检查 MDOC_TOKEN 环境变量，未设置时引导用户创建令牌
• 未提供 articleId 时，获取文档目录清单并以树形结构展示（含文章 ID）
• 提供 articleId 时，获取对应文章的 Markdown 原文
• 每次响应后给出下一步查询建议

---

• 已安装并配置 Claude Code
• M-Doc 个人访问令牌（PAT），通过环境变量 MDOC_TOKEN 提供

---

1. 打开 https://mdoc.cc/settings，进入个人令牌页面。
2. 生成新的 PAT，格式为 mdoc_pat_xxxxxxxxxxxxxxxx。
3. 在终端中导出（建议写入 ~/.zshrc 或 ~/.bashrc 以持久生效）：

export MDOC_TOKEN="mdoc_pat_你的令牌"

若运行技能时未设置 MDOC_TOKEN，技能将自动停止并显示上述配置说明。

---

将以下任意格式作为提示词参数传入：

格式	示例
完整 URL	https://mdoc.cc/mliev/mdoc
带版本的 URL	https://mdoc.cc/mliev/mdoc/v1.0.0
带文章的 URL	https://mdoc.cc/mliev/mdoc/v1.0.0/32
短路径	mliev/mdoc
带版本的短路径	mliev/mdoc/v1.0.0
带文章的短路径	mliev/mdoc/v1.0.0/32

---

获取文档目录清单：

/mdoc mliev/mdoc

输出示例：

📄 mdoc  [版本: master]

  [1] 快速开始
    [3] 安装
    [4] 配置
  [2] API 参考
    [5] 认证
    [6] 端点列表

读取指定文章内容：

/mdoc https://mdoc.cc/mliev/mdoc/v1.0.0/32

输出：直接展示该文章的 Markdown 原文。

---

技能按以下四步执行：

1. 解析参数 — 从输入的 URL 或短路径中提取 orgSlug、docSlug、version（可选）和 articleId（可选）。
2. 检查令牌 — 执行 echo $MDOC_TOKEN；若未设置则停止并提示用户配置。
3. 调用 API —
   • 有 articleId → GET /openapi/organizations/{org}/documents/{doc}/articles/{id}/content.md
   • 无 articleId → GET /openapi/organizations/{org}/documents/{doc}/manifest
4. 展示与建议 — 将目录清单渲染为树形结构，或直接显示 Markdown 原文，并给出后续查询建议。

---

本技能使用的核心端点（均需携带 Authorization: Bearer <token> 请求头）：

端点	说明
GET /openapi/organizations/:orgSlug/documents	列出组织下的所有文档
GET /openapi/organizations/:orgSlug/documents/:docSlug/manifest	获取文档目录清单（TOC）
GET /openapi/organizations/:orgSlug/documents/:docSlug/articles/:articleId/content.md	获取文章 Markdown 内容

完整端点参考：mdoc/references/endpoints.md

---

mdoc-skills/
├── mdoc/
│   ├── SKILL.md                  # 技能定义及执行逻辑
│   └── references/
│       └── endpoints.md          # 完整 OpenAPI 端点参考
├── README.md                     # 英文文档
└── README.zh-CN.md               # 本文件（中文文档）