Agentic Workflows API Documentation Lungo
agntcy/coffeeAgntcy
Authors and maintains the human-facing Agentic Workflows API documentation for the lungo subproject at coffeeAGNTCY/coffeeagents/lungo/docs/workflow-instanceapi.md.
Chinese-language skill that produces API docs from source code, covering OpenAPI specs, endpoint write-ups, SDK usage samples, integration guides, error code tables and auth guides.
SKILL.md written in Chinese; this summary is our English description.
Install API Documentation Generator (Chinese)
$ npx skills add luongnv89/claude-howto --skill doc-generator -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install luongnv89/claude-howto doc-generator --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/luongnv89/claude-howto.git skills-src && mkdir -p .claude/skills && cp -r skills-src/zh/03-skills/doc-generator .claude/skills/doc-generator && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "doc-generator" agent skill from https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generator into .claude/skills/doc-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "doc-generator", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generatorType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add luongnv89/claude-howto --skill doc-generator -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install luongnv89/claude-howto doc-generator --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/luongnv89/claude-howto.git skills-src && mkdir -p .agents/skills && cp -r skills-src/zh/03-skills/doc-generator .agents/skills/doc-generator && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "doc-generator" agent skill from https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generator into .agents/skills/doc-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "doc-generator", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add luongnv89/claude-howto --skill doc-generator -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install luongnv89/claude-howto doc-generator --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/luongnv89/claude-howto.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/zh/03-skills/doc-generator .cursor/skills/doc-generator && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "doc-generator" agent skill from https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generator into .cursor/skills/doc-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "doc-generator", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/luongnv89/claude-howto.git --path zh/03-skills/doc-generator--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add luongnv89/claude-howto --skill doc-generator -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install luongnv89/claude-howto doc-generator --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/luongnv89/claude-howto.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/zh/03-skills/doc-generator .gemini/skills/doc-generator && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "doc-generator" agent skill from https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generator into .gemini/skills/doc-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "doc-generator", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install luongnv89/claude-howto doc-generatorInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add luongnv89/claude-howto --skill doc-generator -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/luongnv89/claude-howto.git skills-src && mkdir -p .github/skills && cp -r skills-src/zh/03-skills/doc-generator .github/skills/doc-generator && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "doc-generator" agent skill from https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generator into .github/skills/doc-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "doc-generator", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add luongnv89/claude-howto --skill doc-generator -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install luongnv89/claude-howto doc-generator --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/luongnv89/claude-howto.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/zh/03-skills/doc-generator .opencode/skills/doc-generator && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "doc-generator" agent skill from https://github.com/luongnv89/claude-howto/tree/main/zh/03-skills/doc-generator into .opencode/skills/doc-generator/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "doc-generator", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
doc-generator- GitHub stars
- 42k
- Token cost
- ~272 tokens
- SKILL.md length
- 16 words
- Files
- 1
- Skills in repo
- 25
- Repo updated
- First seen
- Licence
- MIT
At a glance
Chinese-language skill that produces API docs from source code, covering OpenAPI specs, endpoint write-ups, SDK usage samples, integration guides, error code tables and auth guides.
- Creating API documentation from existing source code
- SKILL.md covers 可生成内容 and 文档结构
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Generating an OpenAPI specification for a backend service
What it does
A Simplified Chinese edition of an API documentation skill, triggered when you want to create or update API docs, generate an OpenAPI specification, or when endpoints and documentation come up. It lists six kinds of output: OpenAPI or Swagger specs, API endpoint documentation, SDK usage examples, integration guides, error code references and authentication guides.
A documentation structure section shows how each endpoint is written up, as a Markdown block that starts with an example GET route and a description heading. The body of that template is mostly cut off in the input, and the folder has no extra scripts or reference files.
When your agent uses it
- Creating API documentation from existing source code
- Generating an OpenAPI specification for a backend service
- Writing SDK usage examples and integration guides for an API
- Refreshing endpoint docs after a release changes the API
Example prompts
- “Read the Express routes in server/routes and generate an OpenAPI spec for them.”
- “Write endpoint documentation for the orders API, including sample requests.”
- “Create an integration guide and an error code table for our public API.”
What it can do on your machine
Read from SKILL.md and the folder at commit 556af8d. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
API Documentation Generator (Chinese) loads about 272 tokens when it runs. Until then it costs about 22 tokens; SKILL.md has 16 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from luongnv89/claude-howto at commit 556af8d, republished under its MIT licence (© luongnv89). 16 words, ~272 tokens.
Download SKILL.mdSave it as
.claude/skills/doc-generator/SKILL.md (or your agent's skills folder).- name
- doc-generator
- description
- 从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范，或在用户提到 API 文档、端点或说明时使用。
API 文档生成 Skill
可生成内容
- OpenAPI / Swagger 规范
- API 端点文档
- SDK 使用示例
- 集成指南
- 错误码参考
- 认证指南
文档结构
每个端点的写法
## GET /api/v1/users/:id
### 描述
简要说明这个端点做什么
### 参数
| 名称 | 类型 | 必填 | 说明 |
|------|------|------|------|
| id | string | 是 | 用户 ID |
### 响应
**200 成功**
```json
{
"id": "usr_123",
"name": "John Doe",
"email": "john@example.com",
"created_at": "2025-01-15T10:30:00Z"
}
```
**404 未找到**
```json
{
"error": "USER_NOT_FOUND",
"message": "User does not exist"
}
```
### 示例
**cURL**
```bash
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
-H "Authorization: Bearer YOUR_TOKEN"
```
**JavaScript**
```javascript
const user = await fetch('/api/v1/users/usr_123', {
headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
```
**Python**
```python
response = requests.get(
'https://api.example.com/api/v1/users/usr_123',
headers={'Authorization': 'Bearer token'}
)
user = response.json()
```© luongnv89, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in zh/03-skills/doc-generator of luongnv89/claude-howto.
Open the folder on GitHubat commit 556af8d
Compare with similar skills
API Documentation Generator (Chinese) next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| API Documentation Generator (Chinese) this skillluongnv89/claude-howto | 42k | — | ~272 | Automated safety check: Pass | MIT | |
| Agentic Workflows API Documentation Lungoagntcy/coffeeAgntcy | 112 | — | ~2.6k | Automated safety check: Pass | Apache-2.0 | |
| OpenAPI Spec Generationwshobson/agents | 40k | 9 repos | ~511 | Automated safety check: Pass | MIT | |
| Docs Interfacesjh941213/my-cc-harness | 126 | — | ~863 | Automated safety check: Notes | None | |
| API DesignMadAppGang/claude-code | 285 | — | ~1.7k | Automated safety check: Pass | MIT | |
| API Design AssistantArabelaTso/Skills-4-SE | 253 | — | ~2.7k | Automated safety check: Pass | Apache-2.0 |
Similar skills
OpenAPI Spec Generation
wshobson/agents
Create, validate and maintain OpenAPI 3.1 specs for REST APIs, whether designed first or generated from existing code, and use them for docs and client SDKs.
Docs Interfaces
jh941213/my-cc-harness
Generate interface/API docs — OpenAPI 3.1/AsyncAPI 3.0 specs, API topology diagrams, interface flow (sequence) diagrams, API changelog.
API Design
MadAppGang/claude-code
A skill your agent uses when designing REST or GraphQL APIs, defining endpoints, implementing pagination/filtering, handling API versioning, or establishing API documentation with OpenAPI/Swagger.
API Design Assistant
ArabelaTso/Skills-4-SE
Design and review APIs with suggestions for endpoints, parameters, return types, and best practices.
Nacos API Doc Update
nacos-group/nacos-group.github.io
Updates Nacos API documentation from Swagger api.json. An agent skill from nacos-group/nacos-group.github.io.
More from luongnv89/claude-howto
All 25 skills in this repoSystematic Code Refactoring
luongnv89/claude-howto
Guides refactoring in phases based on Martin Fowler's method: research, test coverage check, planning and small tested steps, with your approval at each phase.
Code Refactoring Workflow
luongnv89/claude-howto
Guides systematic, test-backed refactoring in the style of Martin Fowler, moving through research, planning and small incremental changes with your approval at each phase.
Blog Post Drafting
luongnv89/claude-howto
Guides drafting a blog post from an idea and optional source material: research, brainstorming, outlining and version-tracked drafts, with user approval at each step.
Brand Voice Guide
luongnv89/claude-howto
Ensure all communication matches brand voice and tone guidelines. Use when creating marketing copy, customer communications, public-facing content, or when…
Code Review Specialist
luongnv89/claude-howto
Reviews code for security, performance, quality and maintainability, using a checklist, a finding template and two metrics scripts.
Claude Code Skill Assessment
luongnv89/claude-howto
Runs a quick or deep quiz on Claude Code skills, scores ten feature areas and generates a personalized learning path with prioritized next steps.
Related
Works with
Categories
Questions about API Documentation Generator (Chinese)
What does API Documentation Generator (Chinese) do?
Chinese-language skill that produces API docs from source code, covering OpenAPI specs, endpoint write-ups, SDK usage samples, integration guides, error code tables and auth guides. A Simplified Chinese edition of an API documentation skill, triggered when you want to create or update API docs, generate an OpenAPI specification, or when endpoints and documentation come up. It lists six kinds of output: OpenAPI or Swagger specs, API endpoint documentation, SDK usage examples, integration guides, error code references and authentication guides.
When should I use API Documentation Generator (Chinese)?
API Documentation Generator (Chinese) fits situations like: creating API documentation from existing source code; generating an OpenAPI specification for a backend service; writing SDK usage examples and integration guides for an API; refreshing endpoint docs after a release changes the API.
How do I install API Documentation Generator (Chinese) in Claude Code?
Run `npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code`. Or copy the skill folder (zh/03-skills/doc-generator in luongnv89/claude-howto) into .claude/skills/doc-generator in your project. Claude Code loads it when a task matches its description.
How do I install API Documentation Generator (Chinese) in Codex?
Run `npx skills add luongnv89/claude-howto --skill doc-generator -a codex`. Or copy the skill folder (zh/03-skills/doc-generator in luongnv89/claude-howto) into .agents/skills/doc-generator in your project. Codex loads it when a task matches its description.
Can I use API Documentation Generator (Chinese) in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add luongnv89/claude-howto --skill doc-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/doc-generator, .gemini/skills/doc-generator, .github/skills/doc-generator and .opencode/skills/doc-generator in your project.
What does API Documentation Generator (Chinese) need to run?
SKILL.md names no scripts, command-line tools or credentials: API Documentation Generator (Chinese) is instructions for the agent only.
Does API Documentation Generator (Chinese) access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is API Documentation Generator (Chinese) safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does API Documentation Generator (Chinese) use?
API Documentation Generator (Chinese) is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does API Documentation Generator (Chinese) use?
About 272 tokens (SKILL.md is roughly 1.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to API Documentation Generator (Chinese)?
Skills that share tags, products or a category with API Documentation Generator (Chinese): Agentic Workflows API Documentation Lungo (agntcy/coffeeAgntcy, 112 stars), OpenAPI Spec Generation (wshobson/agents, 40k stars), Docs Interfaces (jh941213/my-cc-harness, 126 stars) and API Design (MadAppGang/claude-code, 285 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains API Documentation Generator (Chinese)?
luongnv89 (a GitHub user) maintains it in luongnv89/claude-howto, which has 41,779 GitHub stars. The repository holds 25 skills in this directory. The repository was last updated on September 30, 2026.
Source: luongnv89/claude-howto on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.