Getting it into your agent
One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.
npx skills add medalsoftchina/workcopilot --skill doa-apidocgit clone --depth 1 https://github.com/medalsoftchina/workcopilotWrote this? Show the measurements
A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.
[](https://agentmods.dev/skills/medalsoftchina/workcopilot/doa-apidoc)<a href="https://agentmods.dev/skills/medalsoftchina/workcopilot/doa-apidoc"><img src="https://agentmods.dev/badge/skills/medalsoftchina/workcopilot/doa-apidoc/github.svg" alt="Measured on agentmods" height="20"></a>Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.
<a href="https://agentmods.dev/skills/medalsoftchina/workcopilot/doa-apidoc"><img src="https://agentmods.dev/badge/skills/medalsoftchina/workcopilot/doa-apidoc.svg" alt="Reviewed on agentmods" width="80" height="20"></a>What it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00206 | $0.01962 |
| Opus 5 | $0.00103 | $0.00981 |
| Sonnet 5 | $0.00041 | $0.00392 |
| Haiku 4.5 | $0.00021 | $0.00196 |
Grade A, and why
doa-apidoc scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 172 lines — stays where its author put it; the contents beside it link to each section on GitHub.
接口说明文档生成
工作流
用户提供需求/代码 → 确认输出格式(PDF/Word/Both) → AI 结构化整理 → 生成 Python 脚本 → 运行输出文档
Step 0: 确认输出格式
必须在生成前使用 vscode_askQuestions 确认:
问题: 文档输出格式
选项:
- PDF(适合交付/归档) ← recommended
- Word(适合后续编辑)
- 都要
Step 1: 收集与整理接口信息
从用户提供的需求描述、后端代码、或接口定义中,提取并结构化为以下标准章节:
文档元信息(封面)
| 字段 | 说明 |
|---|---|
| 文档标题 | 如「接口说明文档」 |
| 副标题 | 项目名 + 文档类型描述 |
| 文档版本 | V1.0 |
| 编制方 | 默认「{vendor_name}」,用户可覆盖 |
| 接收方 | 文档接收方 |
| 编制日期 | 日期 |
| 文档状态 | 初版发布 / 评审中 / 定稿 |
标准章节结构
| 章节 | 内容要求 |
|---|---|
| 一、接口总览 | 接口清单表格(#/名称/Method/Path/描述)+ 调用链路(ASCII 时序图) |
| 二、公共约定 | 协议、Base URL、鉴权方式、数据格式、公共响应结构、错误码表 |
| 三、接口详细定义 | 每个接口:调用场景 + 请求头 + 入参表 + 入参示例 + 出参表 + 出参示例 + 错误场景 |
| 四、调用时序总结 | 汇总表(步骤/调用方/接口/触发条件/备注) |
每个接口的标准子节
3.x {METHOD} {path} — {接口名}
├─ 调用场景(ColorBox 高亮)
├─ 请求头(如需鉴权)
├─ 入参(表格:参数/类型/必填/说明)
├─ 入参示例(code_block)
├─ 出参(表格:参数/类型/说明)
├─ 出参示例 — 成功 / 失败 / 各状态(code_block)
└─ 错误场景(表格:code/场景)
内容整理原则
- 从代码/需求中推导完整的入参出参,字段名用 camelCase
- 必填字段标记 ✅
- 嵌套对象用
parent[].child格式展示 - 枚举值列出全部可选项及含义
- 错误码覆盖 400/401/404/422/500 等常见场景
- 示例 JSON 使用真实可读的模拟数据
Step 2: 生成文档脚本
根据用户选择的格式,读取对应模板:
- PDF: 读取 references/apidoc-pdf-template.py
- Word: 读取 references/apidoc-word-template.py
基于模板生成定制化 Python 脚本,替换其中的内容数据。
设计规范
颜色体系(商务蓝主题,PDF/Word 通用)
| 角色 | 色值 | 用途 |
|---|---|---|
| pri | #1A365D |
深蓝 - 主标题、表头、页眉线 |
| sec | #2B6CB0 |
中蓝 - 章节标题(h2) |
| acc | #3182CE |
亮蓝 - 小节标题(h3)、强调 |
| lbg | #EBF4FF |
浅蓝背景 - 信息卡片、首列 |
| lgray | #F7FAFC |
极浅灰 - 交替行 |
| border | #CBD5E0 |
边框灰 |
| txt | #2D3748 |
正文色 |
| sub | #718096 |
辅助文字、页眉页脚 |
| green | #276749 |
成功/通过 |
| orange | #C05621 |
警告/待确认 |
| red | #C53030 |
紧急/重要 |
PDF 核心组件
模板提供以下 Flowable 组件:
SectionBar(text, color)— 带色块的章节标题栏(白字 + 圆角深蓝底)InfoCard(rows)— 信息卡片(浅蓝底 + 边框,用于封面元信息)Divider()— 分隔线ColorBox(text, bg, bc)— 调用场景高亮框(浅蓝底 + 蓝色边框)make_table(headers, rows, col_widths)— 标准数据表格(深蓝表头 + 交替行)make_kv_table(rows)— 键值表格(左列浅蓝底粗体 + 右列正文)code_block(text)— 代码块(浅灰底 + 蓝色等宽字体)
What ships with it
2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 9d ago First seen · 172 lines · 206 tokens per session scan A 3d3f9dd2d0ac
doa-apidoc is a skill published in the GitHub repository medalsoftchina/workcopilot (4 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 206 tokens to every session and 1,962 once invoked, about $0.0010 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.
Other skills, from other repositories
thesaurus-get-{word}
Returns synonyms and antonyms for the given word.
pydicom
Use pydicom to read, inspect, write, transform, and safely preflight local DICOM datasets and pixel data. Applies to DICOM metadata, transfer syntaxes, compression plugins, frames, private elements, JSON, and bounded de-identification review.
liteparse
Local document and PDF parsing that returns spatial text with bounding boxes. Use for extracting text from PDFs, DOCX, Office files, and images; running OCR on scans; producing layout-preserved JSON for RAG; batch-ingesting folders of papers; or rendering pages to PNG for multimodal agents. Distinguishing capabilities…
markitdown
Convert heterogeneous documents and selected URIs to Markdown with Microsoft MarkItDown for text analysis, search, and LLM/RAG ingestion. Covers safe local conversion, streams, Office/PDF/data formats, batch workflows, plugins, vision OCR, Azure extraction, and the official MCP server.
open-notebook
Self-hosted, open-source alternative to Google NotebookLM for AI-powered research and document analysis. Use when organizing research materials into notebooks, ingesting diverse content sources (PDFs, videos, audio, web pages, Office documents), generating AI-powered notes and summaries, creating multi-speaker…
pptx-posters
Create and audit editable scientific posters in macro-free PowerPoint (.pptx) from author-approved local content and assets. Use when the requested deliverable is a PowerPoint research/conference poster and exact physical, printer, accessibility, provenance, and package-security checks are required.